org.sonatype.aether.util.listener
Class DefaultTransferEvent

java.lang.Object
  org.sonatype.aether.util.listener.DefaultTransferEvent

All Implemented Interfaces:

TransferEvent

public class DefaultTransferEvent
extends Object
implements TransferEvent

A simple transfer event.

Author:

Benjamin Bentmann

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonatype.aether.transfer.TransferEvent

TransferEvent.EventType, TransferEvent.RequestType

Constructor Summary

DefaultTransferEvent()
Creates a new and uninitialized transfer event.

Method Summary

ByteBuffer	getDataBuffer()
int	getDataLength()
Exception	getException()
TransferEvent.RequestType	getRequestType()
TransferResource	getResource()
long	getTransferredBytes()
TransferEvent.EventType	getType()
DefaultTransferEvent	setDataBuffer(byte[] buffer, int offset, int length) Wraps the given byte[]-array into a ByteBuffer as the content for this event.
DefaultTransferEvent	setDataBuffer(ByteBuffer dataBuffer) Sets the byte buffer holding the transferred bytes since the last event.
DefaultTransferEvent	setException(Exception exception) Sets the error that occurred during the transfer.
DefaultTransferEvent	setRequestType(TransferEvent.RequestType requestType) Sets the type of the request/transfer.
DefaultTransferEvent	setResource(TransferResource resource) Sets the resource being transferred.
DefaultTransferEvent	setTransferredBytes(long transferredBytes) Sets the total number of bytes that have been transferred so far during the download/upload.
DefaultTransferEvent	setType(TransferEvent.EventType type) Sets the type of the event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTransferEvent

public DefaultTransferEvent()

Creates a new and uninitialized transfer event. Use the various setters to populate the event.

Method Detail

getType

public TransferEvent.EventType getType()

Specified by:

getType in interface TransferEvent

setType

public DefaultTransferEvent setType(TransferEvent.EventType type)

Sets the type of the event.

Parameters:

type - The type of the event, must not be null.

Returns:

This event for chaining, never null.

getRequestType

public TransferEvent.RequestType getRequestType()

Specified by:

getRequestType in interface TransferEvent

setRequestType

public DefaultTransferEvent setRequestType(TransferEvent.RequestType requestType)

Sets the type of the request/transfer.

Parameters:

requestType - The request/transfer type, must not be null.

Returns:

This event for chaining, never null.

getResource

public TransferResource getResource()

Specified by:

getResource in interface TransferEvent

setResource

public DefaultTransferEvent setResource(TransferResource resource)

Sets the resource being transferred.

Parameters:

resource - The resource being transferred, must not be null.

Returns:

This event for chaining, never null.

getTransferredBytes

public long getTransferredBytes()

Specified by:

getTransferredBytes in interface TransferEvent

setTransferredBytes

public DefaultTransferEvent setTransferredBytes(long transferredBytes)

Sets the total number of bytes that have been transferred so far during the download/upload.

Parameters:

transferredBytes - The total number of bytes that have been transferred so far during the download/upload, must not be negative.

Returns:

This event for chaining, never null.

getDataLength

public int getDataLength()

Specified by:

getDataLength in interface TransferEvent

getDataBuffer

public ByteBuffer getDataBuffer()

Specified by:

getDataBuffer in interface TransferEvent

setDataBuffer

public DefaultTransferEvent setDataBuffer(byte[] buffer,
                                          int offset,
                                          int length)

Wraps the given byte[]-array into a ByteBuffer as the content for this event.

Parameters:

buffer - The array to use, must not be null.

offset - the starting point of valid bytes in the array.

length - the number of valid bytes.

Returns:

This event for chaining, never null.

setDataBuffer

public DefaultTransferEvent setDataBuffer(ByteBuffer dataBuffer)

Sets the byte buffer holding the transferred bytes since the last event.

Parameters:

dataBuffer - The byte buffer holding the transferred bytes since the last event, may be null.

Returns:

This event for chaining, never null.

getException

public Exception getException()

Specified by:

getException in interface TransferEvent

setException

public DefaultTransferEvent setException(Exception exception)

Sets the error that occurred during the transfer.

Parameters:

exception - The error that occurred during the transfer, may be null if none.

Returns:

This event for chaining, never null.

toString

public String toString()

Overrides:

toString in class Object