Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


com.tangosol.util
Interface BinaryEntry

All Superinterfaces:
InvocableMap.Entry, java.util.Map.Entry, QueryMap.Entry
All Known Implementing Classes:
BackingMapBinaryEntry, ConverterCollections.ConverterMapEvent.ConverterMapEventEntry, ReadWriteBackingMap.Entry

public interface BinaryEntry
extends InvocableMap.Entry

Map.Entry that internally stores both key and value in a Binary format and uses an underlying Serializer to convert it to and from an Object view.

Since:
Coherence 3.5
Author:
as 2009.01.05

Method Summary
 void expire(long cMillis)
          Update the entry with the specified expiry delay.
 ObservableMap getBackingMap()
          Obtain a reference to the backing map that this Entry corresponds to.
 BackingMapContext getBackingMapContext()
          Obtain a reference to the backing map context for the cache that this Entry corresponds to.
 Binary getBinaryKey()
          Return a raw binary key for this entry.
 Binary getBinaryValue()
          Return a raw binary value for this entry.
 BackingMapManagerContext getContext()
          Return the context this entry operates within.
 Binary getOriginalBinaryValue()
          Return a raw original binary value for this entry.
 java.lang.Object getOriginalValue()
          Return an original value for this entry.
 Serializer getSerializer()
          Return a Serializer that is used to serialize/deserialize this entry.
 boolean isReadOnly()
          Check whether this BinaryEntry allows data modification operations.
 void updateBinaryValue(Binary binValue)
          Update the binary value for this entry.

 

Methods inherited from interface com.tangosol.util.InvocableMap.Entry
getKey, getValue, isPresent, remove, setValue, setValue, update

 

Methods inherited from interface com.tangosol.util.QueryMap.Entry
extract

 

Methods inherited from interface java.util.Map.Entry
equals, hashCode

 

Method Detail

getBinaryKey

Binary getBinaryKey()
Return a raw binary key for this entry.
Returns:
a raw binary key for this entry

getBinaryValue

Binary getBinaryValue()
Return a raw binary value for this entry.
Returns:
a raw binary value for this entry; null if the value does not exist

getSerializer

Serializer getSerializer()
Return a Serializer that is used to serialize/deserialize this entry.
Returns:
a Serializer that is used to serialize/deserialize this entry

getContext

BackingMapManagerContext getContext()
Return the context this entry operates within.

Note: This method is a shortcut for the getBackingMapContext.getManagerContext() call.

Returns:
the BackingMapManagerContext for this entry

updateBinaryValue

void updateBinaryValue(Binary binValue)
Update the binary value for this entry.

Passing a non-null binary is functionally equivalent to:

   setValue(getContext().getValueFromInternalConverter().convert(binValue));
 
Passing null value is functionally equivalent to removing the entry.
   remove(false);
 
Parameters:
binValue - a raw binary value to for this entry or null

getOriginalValue

java.lang.Object getOriginalValue()
Return an original value for this entry.
Returns:
an original value for this entry
Since:
Coherence 3.6

getOriginalBinaryValue

Binary getOriginalBinaryValue()
Return a raw original binary value for this entry.
Returns:
a raw original binary value for this entry; null if the original value did not exist
Since:
Coherence 3.6

getBackingMap

ObservableMap getBackingMap()
Obtain a reference to the backing map that this Entry corresponds to. The returned Map should be used in a read-only manner.

Note: This method is a shortcut for the getBackingMapContext.getBackingMap() call. As of Coherence 3.7, the returned type has been narrowed to ObservableMap.

Returns:
the backing map reference; null if the entry does not have any backing map association
Since:
Coherence 3.6

getBackingMapContext

BackingMapContext getBackingMapContext()
Obtain a reference to the backing map context for the cache that this Entry corresponds to.
Returns:
the corresponding BackingMapContext; null if the entry does not have any backing map association
Since:
Coherence 3.7

expire

void expire(long cMillis)
Update the entry with the specified expiry delay.

Note: this method only has an effect only if the associated backing map implements the CacheMap interface

Parameters:
cMillis - the number of milliseconds until the entry will expire; pass CacheMap.EXPIRY_DEFAULT to use the default expiry setting; pass CacheMap.EXPIRY_NEVER to indicate that the entry should never expire
Since:
Coherence 3.7

isReadOnly

boolean isReadOnly()
Check whether this BinaryEntry allows data modification operations.
Returns:
true iff the entry is "read-only"
Since:
Coherence 3.7

Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.