|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.wagon.events.TransferEventSupport
public final class TransferEventSupport
The class allows registration and removal of event listners of type TransferListener and dispatch of those events to those listeners
Field Summary | |
---|---|
private java.util.List |
listeners
registred listeners |
Constructor Summary | |
---|---|
TransferEventSupport()
|
Method Summary | |
---|---|
void |
addTransferListener(TransferListener listener)
Adds the listener to the collection of listeners who will be notifed when any transfer event occurs in this Wagon object. |
void |
fireDebug(java.lang.String message)
Dispatches the given debug message to all registred listeners (calls method TransferListener.debug(String) on all of them. |
void |
fireTransferCompleted(TransferEvent transferEvent)
Dispatches the given TransferEvent
to all registred listeners (calls method TransferListener.transferCompleted(TransferEvent) on all of them}. |
void |
fireTransferError(TransferEvent transferEvent)
Dispatches the given TransferEvent
to all registred listeners (calls method TransferListener.transferError(TransferEvent) on all of them. |
void |
fireTransferInitiated(TransferEvent transferEvent)
Dispatches the given TransferEvent
to all registred listeners (calls method TransferListener.transferInitiated(TransferEvent) on all of them. |
void |
fireTransferProgress(TransferEvent transferEvent,
byte[] buffer,
int length)
Dispatches the given TransferEvent
to all registred listeners (calls method TransferListener.transferProgress(TransferEvent, byte[], int)
on all of them). |
void |
fireTransferStarted(TransferEvent transferEvent)
Dispatches the given TransferEvent
to all registred listeners (calls method TransferListener.transferStarted(TransferEvent) on all of them}. |
boolean |
hasTransferListener(TransferListener listener)
Returns whether the specified instance of transfer listener was added to the collection of listeners who will be notifed when an transfer event occurs |
void |
removeTransferListener(TransferListener listener)
Removes the transfer listener from the collection of listeners so it no longer receives transfer events. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private final java.util.List listeners
Constructor Detail |
---|
public TransferEventSupport()
Method Detail |
---|
public void addTransferListener(TransferListener listener)
Wagon
object.
null
, no exception is thrown and no action is performed
listener
- the transfer listenerremoveTransferListener(org.apache.maven.wagon.events.TransferListener)
,
TransferListener
public void removeTransferListener(TransferListener listener)
null
or specified listener was not added
to this TransferEventSupport
object
no exception is thrown and no action is performed
listener
- the transfer listeneraddTransferListener(TransferListener)
public boolean hasTransferListener(TransferListener listener)
listener
- the transfer listener
true
if given listner was added to the collection of listeners
false
otherwise- See Also:
TransferEvent
,
addTransferListener(TransferListener)
public void fireTransferStarted(TransferEvent transferEvent)
TransferEvent
to all registred listeners (calls method TransferListener.transferStarted(TransferEvent)
on all of them}.
The Event should be of type TransferEvent.TRANSFER_COMPLETED
transferEvent
- the TransferEvent which will be dispached to listenerspublic void fireTransferProgress(TransferEvent transferEvent, byte[] buffer, int length)
TransferEvent
to all registred listeners (calls method TransferListener.transferProgress(TransferEvent, byte[], int)
on all of them). The Event should be of type TransferEvent.TRANSFER_PROGRESS
.
transferEvent
- the TransferEvent which will be dispached to listenersbuffer
- the buffer containing the additional contentlength
- the length of the content in the bufferpublic void fireTransferCompleted(TransferEvent transferEvent)
TransferEvent
to all registred listeners (calls method TransferListener.transferCompleted(TransferEvent)
on all of them}.
The Event should be of type TransferEvent.TRANSFER_COMPLETED
transferEvent
- the TransferEvent which will be dispached to listenerspublic void fireTransferError(TransferEvent transferEvent)
TransferEvent
to all registred listeners (calls method TransferListener.transferError(TransferEvent)
on all of them.
The Event should be of type TransferEvent.TRANSFER_ERROR
and it is expected that
TransferEvent.getException()
} method will return not null value
transferEvent
- the TransferEvent which will be dispached to listenerspublic void fireDebug(java.lang.String message)
TransferListener.debug(String)
on all of them.
message
- the debug message which will be dispached to listenerspublic void fireTransferInitiated(TransferEvent transferEvent)
TransferEvent
to all registred listeners (calls method TransferListener.transferInitiated(TransferEvent)
on all of them.
The Event should be of type TransferEvent.TRANSFER_INITIATED
.
transferEvent
- the TransferEvent which will be dispached to listeners
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |