Package org.alfresco.service.cmr.transfer

Class TransferProgress

java.lang.Object

org.alfresco.service.cmr.transfer.TransferProgress

public class TransferProgress
extends Object

Author:

brian

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TransferProgress.Status

Constructor Summary

Constructors

Constructor	Description
TransferProgress()

Method Summary

Modifier and Type	Method	Description
int	getCurrentPosition()
int	getEndPosition()
Throwable	getError()
TransferProgress.Status	getStatus()
static Set<TransferProgress.Status>	getTerminalStatuses()
boolean	isFinished()
void	setCurrentPosition(int currentPosition)
void	setEndPosition(int endPosition)
void	setError(Throwable error)
void	setStatus(TransferProgress.Status status)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TransferProgress

public TransferProgress()

Method Details

getTerminalStatuses

public static Set<TransferProgress.Status> getTerminalStatuses()

Returns:

The statuses that mark the end of the transfer. Once a transfer reaches one of these statuses it can never move into a different status.

isFinished

public boolean isFinished()

Returns:

true if the current status is one of the terminal statuses.

getStatus

public TransferProgress.Status getStatus()

Returns:

the status

setStatus

public void setStatus(TransferProgress.Status status)

Parameters:

status - the status to set

getCurrentPosition

public int getCurrentPosition()

Returns:

the currentPosition

setCurrentPosition

public void setCurrentPosition(int currentPosition)

Parameters:

currentPosition - the currentPosition to set

getEndPosition

public int getEndPosition()

Returns:

the endPosition

setEndPosition

public void setEndPosition(int endPosition)

Parameters:

endPosition - the endPosition to set

getError

public Throwable getError()

Returns:

the error

setError

public void setError(Throwable error)

Parameters:

error - the error to set

toString

public String toString()

Overrides:

toString in class Object