com.ibm.cloud.objectstorage.event

Class ProgressEvent

java.lang.Object

com.ibm.cloud.objectstorage.event.ProgressEvent

Direct Known Subclasses:

ProgressEvent

@Immutable
public class ProgressEvent
extends Object

A progress event. Typically this is used to notify a chunk of bytes has been transferred. Also used to notify other types of progress events such as a transfer starting, or failing.

The legacy Amazon S3 progress event com.ibm.cloud.objectstorage.services.s3.model.ProgressEvent has been deprecated in favor of this new class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCELED_EVENT_CODE Deprecated. Replaced by ProgressEventType.TRANSFER_CANCELED_EVENT
static int	COMPLETED_EVENT_CODE Deprecated. Replaced by ProgressEventType.TRANSFER_COMPLETED_EVENT
static int	FAILED_EVENT_CODE Deprecated. Replaced by ProgressEventType.TRANSFER_FAILED_EVENT
static int	PART_COMPLETED_EVENT_CODE Deprecated. Replaced by ProgressEventType.TRANSFER_PART_COMPLETED_EVENT
static int	PART_FAILED_EVENT_CODE Deprecated. Replaced by ProgressEventType.TRANSFER_PART_FAILED_EVENT
static int	PART_STARTED_EVENT_CODE Deprecated. Replaced by ProgressEventType.TRANSFER_PART_STARTED_EVENT
static int	PREPARING_EVENT_CODE Deprecated. Replaced by ProgressEventType.TRANSFER_PREPARING_EVENT
static int	RESET_EVENT_CODE Deprecated. Replaced by ProgressEventType.HTTP_REQUEST_CONTENT_RESET_EVENT
static int	STARTED_EVENT_CODE Deprecated. Replaced by ProgressEventType.TRANSFER_STARTED_EVENT

Constructor Summary

Constructors

Constructor and Description
ProgressEvent(long bytes) Deprecated.
ProgressEvent(ProgressEventType eventType) Creates a ProgressEvent object with the specified event type.
ProgressEvent(ProgressEventType eventType, long bytes) Creates a ProgressEvent object.

Method Summary

Modifier and Type	Method and Description
long	getBytes() Returns the number of bytes associated with the event.
long	getBytesTransferred() Convenient method to returns the number of bytes transferred in this event, or the number of bytes reset (or discarded) if negative.
int	getEventCode() Deprecated. Use ProgressEvent.getEventType() instead.
ProgressEventType	getEventType() Returns the type of event this object represents.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PREPARING_EVENT_CODE

@Deprecated
public static final int PREPARING_EVENT_CODE

Deprecated. Replaced by ProgressEventType.TRANSFER_PREPARING_EVENT

See Also:

Constant Field Values

STARTED_EVENT_CODE

@Deprecated
public static final int STARTED_EVENT_CODE

Deprecated. Replaced by ProgressEventType.TRANSFER_STARTED_EVENT

See Also:

Constant Field Values

COMPLETED_EVENT_CODE

@Deprecated
public static final int COMPLETED_EVENT_CODE

Deprecated. Replaced by ProgressEventType.TRANSFER_COMPLETED_EVENT

See Also:

Constant Field Values

FAILED_EVENT_CODE

@Deprecated
public static final int FAILED_EVENT_CODE

Deprecated. Replaced by ProgressEventType.TRANSFER_FAILED_EVENT

See Also:

Constant Field Values

CANCELED_EVENT_CODE

@Deprecated
public static final int CANCELED_EVENT_CODE

Deprecated. Replaced by ProgressEventType.TRANSFER_CANCELED_EVENT

See Also:

Constant Field Values

RESET_EVENT_CODE

@Deprecated
public static final int RESET_EVENT_CODE

Deprecated. Replaced by ProgressEventType.HTTP_REQUEST_CONTENT_RESET_EVENT

See Also:

Constant Field Values

PART_STARTED_EVENT_CODE

@Deprecated
public static final int PART_STARTED_EVENT_CODE

Deprecated. Replaced by ProgressEventType.TRANSFER_PART_STARTED_EVENT

See Also:

Constant Field Values

PART_COMPLETED_EVENT_CODE

@Deprecated
public static final int PART_COMPLETED_EVENT_CODE

Deprecated. Replaced by ProgressEventType.TRANSFER_PART_COMPLETED_EVENT

See Also:

Constant Field Values

PART_FAILED_EVENT_CODE

@Deprecated
public static final int PART_FAILED_EVENT_CODE

Deprecated. Replaced by ProgressEventType.TRANSFER_PART_FAILED_EVENT

See Also:

Constant Field Values

Constructor Detail

ProgressEvent

@Deprecated
public ProgressEvent(long bytes)

Deprecated.

Creates a BYTE_TRANSFER_EVENT with the specified bytesTransferred data.

ProgressEvent

public ProgressEvent(ProgressEventType eventType)

Creates a ProgressEvent object with the specified event type.

Parameters:

eventType - Type of the progress event. This parameter must not be null.

ProgressEvent

public ProgressEvent(ProgressEventType eventType,
                     long bytes)

Creates a ProgressEvent object.

Parameters:

eventType - Type of the progress event. This parameter must not be null.

bytes - Number of bytes involved.

Method Detail

getBytes

public long getBytes()

Returns the number of bytes associated with the event. The number of bytes are not necessarily the same as the number of bytes transferred, and it's meaning depends on the specific event type. For example, the bytes of a ProgressEventType.REQUEST_CONTENT_LENGTH_EVENT refers to the expected number of bytes to be sent to AWS, not the actual number of bytes that have been transferred.

getBytesTransferred

public long getBytesTransferred()

Convenient method to returns the number of bytes transferred in this event, or the number of bytes reset (or discarded) if negative. In particular, bytes of a content-length event is excluded.

getEventCode

@Deprecated
public int getEventCode()

Deprecated. Use ProgressEvent.getEventType() instead.

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.

getEventType

public ProgressEventType getEventType()

Returns the type of event this object represents. This method never returns null.

Returns:

The type of event this object represents.

toString

public String toString()

Overrides:

toString in class Object