Package com.tangosol.coherence.jcache.common

Class JCacheIdentifier

java.lang.Object

com.tangosol.coherence.jcache.common.JCacheIdentifier

All Implemented Interfaces:

ExternalizableLite, PortableObject, Serializable

public class JCacheIdentifier
extends Object
implements ExternalizableLite, PortableObject

An internal class to represent the unique identity of a JCache cache.

Since:

Coherence 12.1.3

Author:

jf 2013.10.24

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JCacheIdentifier()	Constructs JCacheIdentifier
JCacheIdentifier(String sCanonicalCacheName)	Constructs JCacheIdentifier from the internal encoded CoherenceBased cache map name.
JCacheIdentifier(String sMgrUri, String sCacheName)	Constructs JCacheIdentifier

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getCacheManagerURI()	Get the JCache CacheManager URI, a unique identifier for the JCache CacheManager
String	getCanonicalCacheName()	Get the JCache Adapter internal name for this JCacheIdentifier
String	getName()	Get the JCache map name
int	hashCode()
void	readExternal(PofReader pofReader)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput dataInput)	Restore the contents of this object by loading the object's state from the passed DataInput object.
String	toString()
void	writeExternal(PofWriter pofWriter)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput dataOutput)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JCacheIdentifier

public JCacheIdentifier()

Constructs JCacheIdentifier

JCacheIdentifier

public JCacheIdentifier(String sCanonicalCacheName)

Constructs JCacheIdentifier from the internal encoded CoherenceBased cache map name.

Parameters:

sCanonicalCacheName - canonical encoded CoherenceBased cache map name. Name encodes JCache Adapter CacheManager URI, the JCache Adapter implementation type for the JCache map. and the JCache Adapter JCache name.

JCacheIdentifier

public JCacheIdentifier(String sMgrUri,
                        String sCacheName)

Constructs JCacheIdentifier

Parameters:

sMgrUri - unique identifier for CacheManager

sCacheName - JCache name

Method Detail

getName

public String getName()

Get the JCache map name

Returns:

JCache name

getCacheManagerURI

public String getCacheManagerURI()

Get the JCache CacheManager URI, a unique identifier for the JCache CacheManager

Returns:

CacheManager URI context

getCanonicalCacheName

public String getCanonicalCacheName()

Get the JCache Adapter internal name for this JCacheIdentifier

Returns:

internal JCache Adapter coherence-based map name.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

readExternal

public void readExternal(PofReader pofReader)
                  throws IOException

Description copied from interface: PortableObject

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

pofReader - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter pofWriter)
                   throws IOException

Description copied from interface: PortableObject

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

pofWriter - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs

readExternal

public void readExternal(DataInput dataInput)
                  throws IOException

Description copied from interface: ExternalizableLite

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

dataInput - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput dataOutput)
                   throws IOException

Description copied from interface: ExternalizableLite

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

dataOutput - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs