com.starteam
Class CheckinManager.Progress

java.lang.Object
  com.starteam.CheckinManager.Progress

Enclosing class:

CheckinManager

public static final class CheckinManager.Progress
extends java.lang.Object

Information on the progress of a checkin operation from CheckinManager. This provides a snapshot of the progress at the time of request. The values in this class do not change again once the class is created. To retrieve the current progress, use CheckinManager.getProgress().

See Also:

CheckinManager, CheckinManager.getProgress()

Nested Class Summary

static class

CheckinManager.Progress.Phase Information on the phase of a checkin progress of the checkin operation from CheckinManager.

Method Summary

java.lang.Object	clone() Return a snapshot of this Progress object.
CheckinManager.Progress.Phase	getCurrentPhase() Return the Phase associated with this Progress.
long	getCurrentPhaseEstimatedTimeRemaining() Return the estimated time remaining in milliseconds.
long	getCurrentPhaseUnitsOfWork() Get the total number of units of work.
long	getCurrentPhaseUnitsOfWorkProcessed() Return the number of units of work that has been processed in this phase.
long	getCurrentPhaseUnitsOfWorkRemaining() Get the total number of units of work that are yet to be done.
Item	getCurrentStarteamItem() Get the current StarTeam Item object that is being processed in the current phase.
java.io.File	getCurrentWorkingFile() Get the current File object that's being checked in.
java.lang.String	getDescription() Return a description of the current state of Progress.
java.lang.Throwable	getLastError() Get the last error, if any, that occurred during the last checkin operation.
DateTime	getSnapshotTime() Return the snapshot time that is set when the last clone was created.
long	getTotalBytesCheckedIn() Get the total number of bytes that are checked in.
long	getTotalFilesCheckedIn() Return the number of files that have been checked in.
long	getTotalFilesFailed() Get the total number of files that failed during checkin.
long	getTotalFilesForCheckin() Get the total number of files for checkin.
long	getTotalFilesProcessed() Get the total number of files processed.
long	getTotalFilesRemaining() Return the number of files remaining to be checked in.
long	getTotalFilesSkipped() Get the total number of files skipped without being checked in.
long	getTotalTimeSpent() Get the total time spent so far (in milliseconds).
boolean	isInTransaction() return true if the transaction has begun for this checkin
java.lang.String	toString() returns a String representation of the Progress instance now; useful for debugging

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getTotalFilesForCheckin

public long getTotalFilesForCheckin()

Get the total number of files for checkin. The total number of files for checkin is a constant for this instance of the progress object.

Returns:

the total number of files for checkin.

getTotalFilesSkipped

public long getTotalFilesSkipped()

Get the total number of files skipped without being checked in.

Returns:

the total number of files skipped without being checked in.

getTotalFilesFailed

public long getTotalFilesFailed()

Get the total number of files that failed during checkin.

Returns:

Return the files that failed during checkin.

getCurrentPhaseUnitsOfWork

public long getCurrentPhaseUnitsOfWork()

Get the total number of units of work.

Returns:

Return the total number of units of work.

getCurrentPhaseUnitsOfWorkRemaining

public long getCurrentPhaseUnitsOfWorkRemaining()

Get the total number of units of work that are yet to be done.

Returns:

Return the total number of units of work that are yet to be done.

getTotalFilesProcessed

public long getTotalFilesProcessed()

Get the total number of files processed.

Returns:

the total number of files processed.

getTotalBytesCheckedIn

public long getTotalBytesCheckedIn()

Get the total number of bytes that are checked in.

Returns:

the total number of bytes that are checked in.

getTotalTimeSpent

public long getTotalTimeSpent()

Get the total time spent so far (in milliseconds).

Returns:

Return the total time spent so far (in milliseconds).

isInTransaction

public boolean isInTransaction()

return true if the transaction has begun for this checkin

Returns:

true if the transaction has begun for this checkin

getLastError

public java.lang.Throwable getLastError()

Get the last error, if any, that occurred during the last checkin operation.

Returns:

the last error that occurred.

getCurrentPhase

public CheckinManager.Progress.Phase getCurrentPhase()

Return the Phase associated with this Progress.

Returns:

the Phase associated with this Progress.

getTotalFilesCheckedIn

public long getTotalFilesCheckedIn()

Return the number of files that have been checked in.

Returns:

the number of files that have been checked in.

getTotalFilesRemaining

public long getTotalFilesRemaining()

Return the number of files remaining to be checked in.

Returns:

the number of files remaining to be checked in.

getCurrentPhaseUnitsOfWorkProcessed

public long getCurrentPhaseUnitsOfWorkProcessed()

Return the number of units of work that has been processed in this phase.

Returns:

the number of units of work that has been processed in this phase.

getCurrentPhaseEstimatedTimeRemaining

public long getCurrentPhaseEstimatedTimeRemaining()

Return the estimated time remaining in milliseconds.

Returns:

the estimated time remaining in milliseconds.

getDescription

public java.lang.String getDescription()

Return a description of the current state of Progress. It's a string concatenating the name of the Checkin Phase and the File Name.

Returns:

description of the current state of progress of CheckinManager.

getCurrentWorkingFile

public java.io.File getCurrentWorkingFile()

Get the current File object that's being checked in. The return value may be the actual File, or a null if the phase is not a file-processing phase.

Returns:

the current File object that's being checked in in the specified thread ID.

getCurrentStarteamItem

public Item getCurrentStarteamItem()

Get the current StarTeam Item object that is being processed in the current phase. The return value may be an Item if the current phase is iterating over items. Otherwise, a null is returned. For the most part, these Item's are File Objects. However, there can be phases in which other Items are returned, for instance Process Items during a link phase

Returns:

Return the current StarTeam Item that's being processed in the current phase.

clone

public java.lang.Object clone()

Return a snapshot of this Progress object.

Overrides:

clone in class java.lang.Object

Returns:

Object

getSnapshotTime

public DateTime getSnapshotTime()

Return the snapshot time that is set when the last clone was created.

Returns:

DateTime the snapshot time that is set when the last clone was created.

toString

public java.lang.String toString()

returns a String representation of the Progress instance now; useful for debugging

Overrides:

toString in class java.lang.Object

Returns:

String a String representation of the Progress instance now