Hazelcast C++ Client
 All Classes Functions Variables Enumerations Enumerator Pages
Public Member Functions | List of all members
hazelcast::client::EntryArray< K, V > Class Template Referenceabstract

Public Member Functions

virtual size_t size () const =0
 
virtual const K * getKey (size_t index)=0
 Please note that this operation is costly due to de-serialization. More...
 
virtual std::auto_ptr< K > releaseKey (size_t index)=0
 Please note that this operation MAY(if not deserialized previously) be costly due to de-serialization. More...
 
virtual const V * getValue (size_t index)=0
 Please note that this operation is costly due to de-serialization. More...
 
virtual std::auto_ptr< V > releaseValue (size_t index)=0
 Please note that this operation is costly due to de-serialization. More...
 
virtual std::pair< const K
*, const V * > 
operator[] (size_t index)=0
 
virtual void sort (query::IterationType iterationType, const util::Comparator< std::pair< const K *, const V * > > *comparator=0)=0
 Sorts the entries using the comparator if comparator is not null. More...
 

Member Function Documentation

template<typename K , typename V >
virtual const K* hazelcast::client::EntryArray< K, V >::getKey ( size_t  index)
pure virtual

Please note that this operation is costly due to de-serialization.

It caches deserialized data.

Parameters
indexThe index of the desired item in the array.
Returns
Deserializes the data and returns the key object for the data at the provided index.
Exceptions
IllegalArgumentExceptionIf provided index is greater than the maximum array index.
template<typename K , typename V >
virtual const V* hazelcast::client::EntryArray< K, V >::getValue ( size_t  index)
pure virtual

Please note that this operation is costly due to de-serialization.

It will cache the de-serialized data.

Parameters
indexThe index of the desired item in the array.
Returns
Deserializes the data and returns the value object for the data at the provided index.
Exceptions
IllegalArgumentExceptionIf provided index is greater than the maximum array index.
template<typename K , typename V >
virtual std::pair<const K *, const V *> hazelcast::client::EntryArray< K, V >::operator[] ( size_t  index)
pure virtual
Parameters
indexThe index of the desired item in the array.
Returns
The key value pointer pair is returned
template<typename K , typename V >
virtual std::auto_ptr<K> hazelcast::client::EntryArray< K, V >::releaseKey ( size_t  index)
pure virtual

Please note that this operation MAY(if not deserialized previously) be costly due to de-serialization.

It will NOT cache the de-serialized data.

Parameters
indexThe index of the desired item in the array.
Returns
Deserializes the data and returns the key object for the data at the provided index.
Exceptions
IllegalArgumentExceptionIf provided index is greater than the maximum array index.
template<typename K , typename V >
virtual std::auto_ptr<V> hazelcast::client::EntryArray< K, V >::releaseValue ( size_t  index)
pure virtual

Please note that this operation is costly due to de-serialization.

It will NOT cache the de-serialized data.

Parameters
indexThe index of the desired item in the array.
Returns
Deserializes the data and returns the value object for the data at the provided index.
Exceptions
IllegalArgumentExceptionIf provided index is greater than the maximum array index.
template<typename K , typename V >
virtual size_t hazelcast::client::EntryArray< K, V >::size ( ) const
pure virtual
Returns
Returns the number of data items
template<typename K , typename V >
virtual void hazelcast::client::EntryArray< K, V >::sort ( query::IterationType  iterationType,
const util::Comparator< std::pair< const K *, const V * > > *  comparator = 0 
)
pure virtual

Sorts the entries using the comparator if comparator is not null.

Otherwise, sorts based on the provided iterationType value.

Parameters
iterationTypeif null comparator is provided then iteration type is query::VALUE, the entry value should not be null and the entries shall be sorted by value, otherwise the entries shall be sorted by key.

The documentation for this class was generated from the following file: