com.starbase.starteam
Class CheckinProgress

java.lang.Object
  |
  +--com.starbase.starteam.CheckinProgress

public class CheckinProgress

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()

Method Summary

java.lang.Object	clone() Return a snapshot of this CheckinProgress object.
CheckinPhase	getCheckinPhase() Return the CheckinPhase associated with this CheckinProgress.
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 CheckinProgress.
java.lang.Throwable	getLastError() Get the last error, if any, that occurred during the last checkin operation.
OLEDate	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 to be checked in.
long	getTotalFilesRemaining() Return the number of files left to be checked in.
long	getTotalFilesSkipped() Get the total number of files skipped without being checked in.
long	getTotalTimeSpent() Get the time spent on checking in in milliseconds.
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

getCheckinPhase

public CheckinPhase getCheckinPhase()

Return the CheckinPhase associated with this CheckinProgress.

Returns:

the CheckinPhase associated with this CheckinProgress.

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 left to be checked in.

Returns:

the number of files left to be checked in.

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:

Return the total number of files for checkin.

getTotalFilesSkipped

public long getTotalFilesSkipped()

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

Returns:

Return 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 total number of 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 to be checked in.

Returns:

Return the total number of files to be checked in.

getTotalBytesCheckedIn

public long getTotalBytesCheckedIn()

Get the total number of bytes that are checked in.

Returns:

Return the total number of bytes that are checked in.

getTotalTimeSpent

public long getTotalTimeSpent()

Get the time spent on checking in in milliseconds.

Returns:

Return the time spent on checking in in milliseconds.

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 CheckinProgress. It's a string concatenating the name of the CheckPhase and the File Name.

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:

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

clone

public java.lang.Object clone()

Return a snapshot of this CheckinProgress object.

Overrides:

clone in class java.lang.Object

Returns:

Object

getSnapshotTime

public OLEDate 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.

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 currenet 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.

getLastError

public java.lang.Throwable getLastError()

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

Returns:

Return the last error that occurred.

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