TransferEvent (Java API Reference for Oracle® Coherence Community Edition)

All Superinterfaces:

Event<TransferEvent.Type>, Event<TransferEvent.Type>

All Known Subinterfaces:

TransferEvent.RecoveryTransferEvent
```
public interface TransferEvent
extends Event<TransferEvent.Type>
```
A TransferEvent captures information concerning the transfer of a partition for a storage enabled member. Transfer events are raised against the set of entries that are being transferred.
Note: TransferEvents are dispatched to interceptors while holding a lock on the partition for being transferred, blocking any operations for the partition.

Since:

Coherence 12.1.2

Author:

rhl/hr/gg 2012.09.21

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`TransferEvent.RecoveryTransferEvent`	A RecoveryTransferEvent is raised due to the recovery of a partition from a persistent store.
`static class`	`TransferEvent.Type`	The `TransferEvent` types.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Map<String,Set<BinaryEntry>>`	`getEntries()`	Return a map of cache names and associated set of read-only `entries` encapsulated in this `TransferEvent`.
`Member`	`getLocalMember()`	Return the local `Member` associated with this transfer operation.
`int`	`getPartitionId()`	Return the ID of the partition being transferred.
`Member`	`getRemoteMember()`	Return the remote `Member` associated with this transfer operation.

Methods inherited from interface com.tangosol.net.events.Event
getType, nextInterceptor

Methods inherited from interface com.tangosol.net.events.partition.Event
getDispatcher, getService

- Method Detail
  - getPartitionId
```
int getPartitionId()
```
    Return the ID of the partition being transferred.
    
    Returns:
    
    the ID of the partition being transferred
  - getLocalMember
```
Member getLocalMember()
```
    Return the local Member associated with this transfer operation. For the DEPARTING event this is the member the entries are being transferred from. For the ARRIVED event, this is the member that is receiving the entries.
    
    Returns:
    
    the local Member associated with this event
  - getRemoteMember
```
Member getRemoteMember()
```
    Return the remote Member associated with this transfer operation. For the DEPARTING event this is the member the entries are being transferred to. For the ARRIVED event, this is the member that the entries are being transferred from.
    In the case the ARRIVED event, the returned member could be null, indicating a "partition restore" operation.
    
    Returns:
    
    the remote Member associated with this event
  - getEntries
```
Map<String,Set<BinaryEntry>> getEntries()
```
    Return a map of cache names and associated set of read-only entries encapsulated in this TransferEvent. The returned map and contained sets are immutable.
    
    Returns:
    
    a map of cache names and associated set of entries