Package org.apache.maven.wagon.events
Class TransferEventSupport
java.lang.Object
org.apache.maven.wagon.events.TransferEventSupport
The class allows registration and removal of event listeners of type
TransferListener and dispatch of those events to those listeners
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddTransferListener(TransferListener listener) Adds the listener to the collection of listeners who will be notified when any transfer event occurs in thisWagonobject.voidDispatches the given debug message to all registered listeners (calls methodTransferListener.debug(String)on all of them.voidfireTransferCompleted(TransferEvent transferEvent) Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferCompleted(TransferEvent)on all of them}.voidfireTransferError(TransferEvent transferEvent) Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferError(TransferEvent)on all of them.voidfireTransferInitiated(TransferEvent transferEvent) Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferInitiated(TransferEvent)on all of them.voidfireTransferProgress(TransferEvent transferEvent, byte[] buffer, int length) Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferProgress(TransferEvent, byte[], int)on all of them).voidfireTransferStarted(TransferEvent transferEvent) Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferStarted(TransferEvent)on all of them}.booleanhasTransferListener(TransferListener listener) Returns whether the specified instance of transfer listener was added to the collection of listeners who will be notified when an transfer event occursvoidremoveTransferListener(TransferListener listener) Removes the transfer listener from the collection of listeners so it no longer receives transfer events.
-
Field Details
-
listeners
registered listeners
-
-
Constructor Details
-
TransferEventSupport
public TransferEventSupport()
-
-
Method Details
-
addTransferListener
Adds the listener to the collection of listeners who will be notified when any transfer event occurs in thisWagonobject.
If listener isnull, no exception is thrown and no action is performed- Parameters:
listener- the transfer listener- See Also:
-
removeTransferListener
Removes the transfer listener from the collection of listeners so it no longer receives transfer events.
If listener isnullor specified listener was not added to thisTransferEventSupportobject no exception is thrown and no action is performed- Parameters:
listener- the transfer listener- See Also:
-
hasTransferListener
Returns whether the specified instance of transfer listener was added to the collection of listeners who will be notified when an transfer event occurs- Parameters:
listener- the transfer listener- Returns:
trueif given listener was added to the collection of listenersfalseotherwise- See Also:
-
fireTransferStarted
Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferStarted(TransferEvent)on all of them}. The Event should be of typeTransferEvent.TRANSFER_COMPLETED- Parameters:
transferEvent- the TransferEvent which will be dispatched to listeners
-
fireTransferProgress
Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferProgress(TransferEvent, byte[], int)on all of them). The Event should be of typeTransferEvent.TRANSFER_PROGRESS.- Parameters:
transferEvent- the TransferEvent which will be dispatched to listenersbuffer- the buffer containing the additional contentlength- the length of the content in the buffer
-
fireTransferCompleted
Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferCompleted(TransferEvent)on all of them}. The Event should be of typeTransferEvent.TRANSFER_COMPLETED- Parameters:
transferEvent- the TransferEvent which will be dispatched to listeners
-
fireTransferError
Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferError(TransferEvent)on all of them. The Event should be of typeTransferEvent.TRANSFER_ERRORand it is expected thatTransferEvent.getException()} method will return not null value- Parameters:
transferEvent- the TransferEvent which will be dispatched to listeners
-
fireDebug
Dispatches the given debug message to all registered listeners (calls methodTransferListener.debug(String)on all of them.- Parameters:
message- the debug message which will be dispatched to listeners
-
fireTransferInitiated
Dispatches the givenTransferEventto all registered listeners (calls methodTransferListener.transferInitiated(TransferEvent)on all of them. The Event should be of typeTransferEvent.TRANSFER_INITIATED.- Parameters:
transferEvent- the TransferEvent which will be dispatched to listeners
-