com.hazelcast.nio.serialization

Interface Portable

All Known Subinterfaces:

VersionedPortable

All Known Implementing Classes:

AbstractAlterRequest, AbstractAlterRequest, AbstractCacheRequest, AbstractCredentials, AbstractIsLockedRequest, AbstractLockRequest, AbstractMapAddEntryListenerRequest, AbstractReplicatedMapClientRequest, AbstractTxnMapRequest, AbstractUnlockRequest, AcquireRequest, AddAllRequest, AddAllRequest, AddAndGetRequest, AddDistributedObjectListenerRequest, AddEntryListenerRequest, AddListenerRequest, AddMembershipListenerRequest, AddMessageListenerRequest, AddPartitionLostListenerRequest, AddRequest, AllPartitionsClientRequest, AlterAndGetRequest, AlterAndGetRequest, AlterRequest, AlterRequest, ApplyRequest, ApplyRequest, AtomicLongRequest, AuthenticationRequest, AvailableRequest, AwaitRequest, AwaitRequest, BaseClientAddListenerRequest, BaseClientRemoveListenerRequest, BaseTransactionRequest, BaseXATransactionRequest, BeforeAwaitRequest, CacheAddEntryListenerRequest, CacheAddInvalidationListenerRequest, CacheAddPartitionLostListenerRequest, CacheBatchInvalidationMessage, CacheClearRequest, CacheContainsKeyRequest, CacheCreateConfigRequest, CacheDestroyRequest, CacheEntryProcessorRequest, CacheGetAllRequest, CacheGetAndRemoveRequest, CacheGetAndReplaceRequest, CacheGetConfigRequest, CacheGetRequest, CacheInvalidationMessage, CacheIterateRequest, CacheListenerRegistrationRequest, CacheLoadAllRequest, CacheManagementConfigRequest, CachePutAllRequest, CachePutIfAbsentRequest, CachePutRequest, CacheRemoveEntryListenerRequest, CacheRemoveInvalidationListenerRequest, CacheRemovePartitionLostListenerRequest, CacheRemoveRequest, CacheReplaceRequest, CacheSingleInvalidationMessage, CacheSizeRequest, CallableClientRequest, CancellationRequest, CapacityRequest, ClearRemoteTransactionRequest, ClearRequest, ClearRequest, ClientCancellationRequest, ClientCreateRequest, ClientDestroyRequest, ClientJobProcessInformationRequest, ClientMapReduceRequest, ClientPingRequest, ClientPrincipal, ClientReplicatedMapAddEntryListenerRequest, ClientReplicatedMapAddNearCacheListenerRequest, ClientReplicatedMapClearRequest, ClientReplicatedMapContainsKeyRequest, ClientReplicatedMapContainsValueRequest, ClientReplicatedMapEntrySetRequest, ClientReplicatedMapGetRequest, ClientReplicatedMapIsEmptyRequest, ClientReplicatedMapKeySetRequest, ClientReplicatedMapPutAllRequest, ClientReplicatedMapPutTtlRequest, ClientReplicatedMapRemoveEntryListenerRequest, ClientReplicatedMapRemoveRequest, ClientReplicatedMapSizeRequest, ClientReplicatedMapValuesRequest, ClientRequest, CollectionAddAllRequest, CollectionAddListenerRequest, CollectionAddRequest, CollectionClearRequest, CollectionCompareAndRemoveRequest, CollectionContainsRequest, CollectionGetAllRequest, CollectionIsEmptyRequest, CollectionRemoveListenerRequest, CollectionRemoveRequest, CollectionRequest, CollectionSizeRequest, CollectXATransactionsRequest, CommitTransactionRequest, CommitXATransactionRequest, CompareAndRemoveRequest, CompareAndSetRequest, CompareAndSetRequest, ContainsRequest, ContainsRequest, ContainsRequest, CountDownRequest, CountRequest, CreateTransactionRequest, CreateXATransactionRequest, DistributedObjectInfo, DrainRequest, DrainRequest, EntrySetRequest, FinalizeXATransactionRequest, GenericError, GetAllRequest, GetAndAddRequest, GetAndAlterRequest, GetAndAlterRequest, GetAndSetRequest, GetAndSetRequest, GetCountRequest, GetDistributedObjectsRequest, GetLockCountRequest, GetMemberListRequest, GetPartitionsRequest, GetRemainingLeaseRequest, GetRequest, HeadSequenceRequest, InitRequest, InvocationClientRequest, IsEmptyRequest, IsLockedRequest, IsNullRequest, IsShutdownRequest, IteratorRequest, KeyBasedClientRequest, KeyBasedContainsRequest, KeySetRequest, ListAddAllRequest, ListAddRequest, ListGetRequest, ListIndexOfRequest, ListRemoveRequest, ListSetRequest, ListSubRequest, LockRequest, MapAddEntryListenerRequest, MapAddEntryListenerSqlRequest, MapAddIndexRequest, MapAddInterceptorRequest, MapAddNearCacheEntryListenerRequest, MapAddPartitionLostListenerRequest, MapAllPartitionsClientRequest, MapClearNearCacheRequest, MapClearRequest, MapContainsKeyRequest, MapContainsValueRequest, MapDeleteRequest, MapEvictAllRequest, MapEvictRequest, MapExecuteOnAllKeysRequest, MapExecuteOnKeyRequest, MapExecuteOnKeysRequest, MapExecuteWithPredicateRequest, MapFlushRequest, MapGetAllRequest, MapGetEntryViewRequest, MapGetRequest, MapIsEmptyRequest, MapIsLockedRequest, MapKeyBasedClientRequest, MapLoadAllKeysRequest, MapLoadGivenKeysRequest, MapLockRequest, MapPartitionClientRequest, MapPutAllRequest, MapPutIfAbsentRequest, MapPutRequest, MapPutTransientRequest, MapQueryRequest, MapRemoveEntryListenerRequest, MapRemoveIfSameRequest, MapRemoveInterceptorRequest, MapRemovePartitionLostListenerRequest, MapRemoveRequest, MapReplaceIfSameRequest, MapReplaceRequest, MapSetRequest, MapSizeRequest, MapSQLQueryRequest, MapTryPutRequest, MapTryRemoveRequest, MapUnlockRequest, ModifyRequest, MultiMapAllPartitionRequest, MultiMapIsLockedRequest, MultiMapKeyBasedRequest, MultiMapLockRequest, MultiMapRequest, MultiMapUnlockRequest, MultiPartitionClientRequest, MultiTargetClientRequest, OfferRequest, PartitionClientRequest, PartitionTargetCallableRequest, PeekRequest, PollRequest, PortableCachePartitionLostEvent, PortableCollection, PortableDistributedObjectEvent, PortableEntryEvent, PortableEntrySetResponse, PortableItemEvent, PortableMapPartitionLostEvent, PortableMessage, PortablePartitionLostEvent, PortableReadResultSet, PrepareXATransactionRequest, PublishRequest, PutRequest, QueueRequest, ReadManyRequest, ReadOneRequest, ReadRequest, ReadRequest, ReduceRequest, RegisterMembershipListenerRequest, ReleaseRequest, RemainingCapacityRequest, RemainingCapacityRequest, RemoveAllListeners, RemoveAllRequest, RemoveDistributedObjectListenerRequest, RemoveEntryListenerRequest, RemoveListenerRequest, RemoveMessageListenerRequest, RemovePartitionLostListenerRequest, RemoveRequest, RemoveRequest, ReplicatedMapEntries, ReplicatedMapKeys, ReplicatedMapPortableEntryEvent, ReplicatedMapValueCollection, RingbufferRequest, RollbackTransactionRequest, RollbackXATransactionRequest, SemaphoreRequest, SetCountRequest, SetRequest, SetRequest, ShutdownRequest, SignalRequest, SizeRequest, SizeRequest, SizeRequest, SpecificTargetCallableRequest, TailSequenceRequest, TargetClientRequest, TransferableJobProcessInformation, TxnCollectionRequest, TxnListAddRequest, TxnListRemoveRequest, TxnListSizeRequest, TxnMapRequest, TxnMapRequestWithSQLQuery, TxnMultiMapGetRequest, TxnMultiMapPutRequest, TxnMultiMapRemoveAllRequest, TxnMultiMapRemoveRequest, TxnMultiMapRequest, TxnMultiMapSizeRequest, TxnMultiMapValueCountRequest, TxnOfferRequest, TxnPeekRequest, TxnPollRequest, TxnSetAddRequest, TxnSetRemoveRequest, TxnSetSizeRequest, TxnSizeRequest, UnlockRequest, UsernamePasswordCredentials, ValuesRequest

public interface Portable

Portable provides an alternative serialization method. Instead of relying on reflection, each Portable is created by a registered PortableFactory.

Portable serialization that have the following advantages:

• Support multiversion of the same object type. (See SerializationConfig.setPortableVersion(int))
• Fetching individual fields without having to rely on reflection.
• Querying and indexing support without de-serialization and/or reflection.

See Also:

PortableFactory, PortableWriter, PortableReader, ClassDefinition, DataSerializable, IdentifiedDataSerializable, SerializationConfig

Method Summary

Methods

Modifier and Type	Method and Description
int	getClassId() Returns class identifier for this portable class.
int	getFactoryId() Returns PortableFactory id for this portable class
void	readPortable(PortableReader reader) Read portable fields using PortableReader
void	writePortable(PortableWriter writer) Serialize this portable object using PortableWriter

Method Detail

getFactoryId

int getFactoryId()

Returns PortableFactory id for this portable class

Returns:

factory id

getClassId

int getClassId()

Returns class identifier for this portable class. Class id should be unique per PortableFactory.

Returns:

class id

writePortable

void writePortable(PortableWriter writer)
                   throws IOException

Serialize this portable object using PortableWriter

Parameters:

writer - PortableWriter

Throws:

IOException

readPortable

void readPortable(PortableReader reader)
                  throws IOException

Read portable fields using PortableReader

Parameters:

reader - PortableReader

Throws:

IOException