com.starbase.starteam
Class CheckoutProgress

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

public class CheckoutProgress

extends java.lang.Object

Information on the progress of a checkout operation from CheckoutManager. 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 CheckoutManager.getProgress().

See Also:

CheckoutManager, CheckoutManager.getProgress()

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
long	getCurrentBytesExpected(int threadIndex) Get the number of bytes to be expected from the thread represented by the specified thread ID.
long	getCurrentBytesSoFar(int threadIndex) Get the number of bytes checked out so far for the file that's in the thread represented by the specified thread ID.
File	getCurrentFile(int threadIndex) Get the current File object that's being checked out in the specified thread ID.
java.lang.Throwable	getLastError() Get the last error, if any, that occurred during the last checkout operation.
int	getNumCheckoutThreads() Get the number of threads that contains checkout operations.
long	getTotalBytesCheckedOut() Get the total number of bytes that are checked out.
long	getTotalBytesCheckedOut(int threadIndex) Get the number of bytes checked out from the thread represented by the specified thread ID.
long	getTotalBytesCheckedOutByMPXCacheAgent() Get the number of bytes checked out through MPX File Cache Agent.
long	getTotalCommandTime() Get the time spent on checking out in milliseconds.
long	getTotalCommandTimeByMPXCacheAgent() Get the time spent on checking out in milliseconds through MPX File Cache Agent.
int	getTotalFilesCheckedOut() Get the total number of files checked out.
int	getTotalFilesCheckedOut(int threadIndex) Get the number of files checked out that's in the thread represented by the specified thread ID.
int	getTotalFilesCheckedOutByMPXCacheAgent() Get the number of files checked out through MPX File Cache Agent.
int	getTotalFilesFailed() Get the total number of files that failed during checkout.
int	getTotalFilesRemaining() Get the total number of files that are yet to be checked out.
int	getTotalFilesSkipped() Get the total number of files skipped without being checked out.
int	getTotalFilesSkippedByMPXCacheAgent() Get the number of files skipped without being checked out through MPX File Cache Agent.
int	hashCode() returns a unique hash for all instances of this type
boolean	isMPXCacheAgentThread(int threadIndex) Determine if a given number represent the thread ID of a thread that contains checkout operations through MPX File Cache Agent.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTotalFilesCheckedOut

public int getTotalFilesCheckedOut()

Get the total number of files checked out.

Returns:

Return the total number of files checked out.

getTotalFilesSkipped

public int getTotalFilesSkipped()

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

Returns:

Return the total number of files skipped without being checked out.

getTotalFilesFailed

public int getTotalFilesFailed()

Get the total number of files that failed during checkout.

Returns:

Return the total number of files that failed during checkout.

getTotalFilesRemaining

public int getTotalFilesRemaining()

Get the total number of files that are yet to be checked out.

Returns:

Return the total number of files that are yet to be checked out.

getTotalBytesCheckedOut

public long getTotalBytesCheckedOut()

Get the total number of bytes that are checked out.

Returns:

Return the total number of bytes that are checked out.

getTotalCommandTime

public long getTotalCommandTime()

Get the time spent on checking out in milliseconds.

Returns:

Return the time spent on checking out in milliseconds.

getTotalCommandTimeByMPXCacheAgent

public long getTotalCommandTimeByMPXCacheAgent()

Get the time spent on checking out in milliseconds through MPX File Cache Agent.

Returns:

Return the time spent on checking out in milliseconds through MPX File Cache Agent.

getTotalFilesCheckedOutByMPXCacheAgent

public int getTotalFilesCheckedOutByMPXCacheAgent()

Get the number of files checked out through MPX File Cache Agent.

Returns:

Return the number of files checked out through MPX File Cache Agent.

getTotalFilesSkippedByMPXCacheAgent

public int getTotalFilesSkippedByMPXCacheAgent()

Get the number of files skipped without being checked out through MPX File Cache Agent.

Returns:

Return the number of files skipped without being checked out through MPX File Cache Agent.

getTotalBytesCheckedOutByMPXCacheAgent

public long getTotalBytesCheckedOutByMPXCacheAgent()

Get the number of bytes checked out through MPX File Cache Agent.

Returns:

Return the number of bytes checked out through MPX File Cache Agent.

getNumCheckoutThreads

public int getNumCheckoutThreads()

Get the number of threads that contains checkout operations.

Returns:

Return the number of threads that contains checkout operations.

isMPXCacheAgentThread

public boolean isMPXCacheAgentThread(int threadIndex)

Determine if a given number represent the thread ID of a thread that contains checkout operations through MPX File Cache Agent.

Parameters:

threadIndex - The number to be determined if it represents the thread ID of a thread that contains checkout operations through MPX File Cache Agent.

Returns:

Return true if the given number represent the thread ID of a thread that contains checkout operations through MPX File Cache Agent.

getCurrentFile

public File getCurrentFile(int threadIndex)

Get the current File object that's being checked out in the specified thread ID. The return value may be the actual File if the thread ID is valid, and that there is still checkout operation currently. Otherwise, a null is returned.

Parameters:

threadIndex - The thread ID of a thread.

Returns:

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

getCurrentBytesExpected

public long getCurrentBytesExpected(int threadIndex)

Get the number of bytes to be expected from the thread represented by the specified thread ID. The return value may be the actual number if the thread ID is valid, and that there is still checkout operation currently. Otherwise, a zero is returned.

Parameters:

threadIndex - The thread ID of a thread.

Returns:

Return the number of bytes to be expected from the thread represented by the specified thread ID.

getCurrentBytesSoFar

public long getCurrentBytesSoFar(int threadIndex)

Get the number of bytes checked out so far for the file that's in the thread represented by the specified thread ID. The return value may be the actual number if the thread ID is valid, and that there is still checkout operation currently. Otherwise, a zero is returned.

Parameters:

threadIndex - The thread ID of a thread.

Returns:

Return the number of bytes checked out so far for the file that's in the thread represented by the specified thread ID.

getTotalFilesCheckedOut

public int getTotalFilesCheckedOut(int threadIndex)

Get the number of files checked out that's in the thread represented by the specified thread ID. The return value may be the actual number if the thread ID is valid. Otherwise, a zero is returned.

Parameters:

threadIndex - The thread ID of a thread.

Returns:

Return the number of files checked out that's in the thread represented by the specified thread ID.

getTotalBytesCheckedOut

public long getTotalBytesCheckedOut(int threadIndex)

Get the number of bytes checked out from the thread represented by the specified thread ID. The return value may be the actual number if the thread ID is valid. Otherwise, a zero is returned.

Parameters:

threadIndex - The thread ID of a thread.

Returns:

Return the number of bytes checked out from the thread represented by the specified thread ID.

getLastError

public java.lang.Throwable getLastError()

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

Returns:

Return the last error that occurred.

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type