com.amazonaws.event

Class ProgressEvent

java.lang.Object

com.amazonaws.event.ProgressEvent

public class ProgressEvent
extends java.lang.Object

Notification of a progress change on a transfer. Typically this means notice that another chunk of bytes was transferred, but it also signals other types of progress events such as a transfer starting, or failing.

This class could be used for both Amazon S3 and Amazon Glacier clients. The legacy Amazon S3 progress event com.amazonaws.services.s3.model.ProgressEvent has been deprecated in favor of this new class.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	bytesTransferred The number of bytes transferred since the last progress event.
static int	CANCELED_EVENT_CODE Event code for canceled.
static int	COMPLETED_EVENT_CODE Event code for completed.
protected int	eventCode The unique event code identifying the type of event this object represents.
static int	FAILED_EVENT_CODE Event code for failed.
static int	PART_COMPLETED_EVENT_CODE Event code for multipart completed.
static int	PART_FAILED_EVENT_CODE Event code for multipart failed.
static int	PART_STARTED_EVENT_CODE Event code for multipart started.
static int	PREPARING_EVENT_CODE Event code for preparing.
static int	RESET_EVENT_CODE Event code for reset.
static int	STARTED_EVENT_CODE Event code for started.

Constructor Summary

Constructors

Constructor and Description
ProgressEvent(int eventCode, long bytesTransferred) Constructor.
ProgressEvent(long bytesTransferred) Constructor.

Method Summary

Modifier and Type	Method and Description
long	getBytesTransferred() Returns the number of bytes transferred since the last progress event.
int	getEventCode() Returns the unique event code identifying the type of event this object represents.
void	setBytesTransferred(long bytesTransferred) Sets the number of bytes transferred since the last progress event.
void	setEventCode(int eventType) Sets the unique event code identifying the type of event this object represents.

Methods inherited from class java.lang.Object

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

Field Detail

PREPARING_EVENT_CODE

public static final int PREPARING_EVENT_CODE

Event code for preparing.

See Also:

Constant Field Values

STARTED_EVENT_CODE

public static final int STARTED_EVENT_CODE

Event code for started.

See Also:

Constant Field Values

COMPLETED_EVENT_CODE

public static final int COMPLETED_EVENT_CODE

Event code for completed.

See Also:

Constant Field Values

FAILED_EVENT_CODE

public static final int FAILED_EVENT_CODE

Event code for failed.

See Also:

Constant Field Values

CANCELED_EVENT_CODE

public static final int CANCELED_EVENT_CODE

Event code for canceled.

See Also:

Constant Field Values

RESET_EVENT_CODE

public static final int RESET_EVENT_CODE

Event code for reset.

See Also:

Constant Field Values

PART_STARTED_EVENT_CODE

public static final int PART_STARTED_EVENT_CODE

Event code for multipart started.

See Also:

Constant Field Values

PART_COMPLETED_EVENT_CODE

public static final int PART_COMPLETED_EVENT_CODE

Event code for multipart completed.

See Also:

Constant Field Values

PART_FAILED_EVENT_CODE

public static final int PART_FAILED_EVENT_CODE

Event code for multipart failed.

See Also:

Constant Field Values

bytesTransferred

protected long bytesTransferred

The number of bytes transferred since the last progress event.

eventCode

protected int eventCode

The unique event code identifying the type of event this object represents.

Constructor Detail

ProgressEvent

public ProgressEvent(long bytesTransferred)

Constructor.

Parameters:

bytesTransferred - the bytes transferred.

ProgressEvent

public ProgressEvent(int eventCode,
                     long bytesTransferred)

Constructor.

Parameters:

eventCode - the event code.

bytesTransferred - the bytes transferred.

Method Detail

setBytesTransferred

public void setBytesTransferred(long bytesTransferred)

Sets the number of bytes transferred since the last progress event.

Parameters:

bytesTransferred - The number of bytes transferred since the last progress event.

getBytesTransferred

public long getBytesTransferred()

Returns the number of bytes transferred since the last progress event.

Returns:

The number of bytes transferred since the last progress event.

getEventCode

public int getEventCode()

Returns the unique event code identifying the type of event this object represents.

Returns:

The unique event code that identifies what type of specific type of event this object represents.

setEventCode

public void setEventCode(int eventType)

Sets the unique event code identifying the type of event this object represents.

Parameters:

eventType - The unique event code that identifies what type of specific type of event this object represents.