Class ClusteredProperties

java.lang.Object

com.oracle.coherence.concurrent.executor.ClusteredProperties

All Implemented Interfaces:

Task.Properties, ExternalizableLite, PortableObject, Serializable

public class ClusteredProperties
extends Object
implements Task.Properties, ExternalizableLite, PortableObject

A clustered implementation of a Task.Properties.

Since:

21.12

Author:

bo, lh

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusteredProperties.PropertyKey<T extends Serializable>	Property key.
static class	ClusteredProperties.PropertyValue<T extends Serializable>	Property value.
static class	ClusteredProperties.SetPropertyValueProcessor<K extends Serializable, V extends Serializable>	An InvocableMap.EntryProcessor for inserting/updating ClusteredProperties.PropertyKey/ClusteredProperties.PropertyValue mappings.

Field Summary

Fields

Modifier and Type	Field	Description
protected CacheService	m_service	The CacheService used by the Task, hence the property cache.
protected String	m_sTaskId	The Task ID.

Constructor Summary

Constructors

Constructor	Description
ClusteredProperties()	Constructs an ClusteredProperties (required for serialization).
ClusteredProperties(String sTaskId, CacheService service)	Constructs a ClusteredProperties given the task ID and cache service.
ClusteredProperties(String sTaskId, CacheService service, TaskProperties properties)	Constructs a ClusteredProperties given the task ID, cache service, and initial properties.

Method Summary

Modifier and Type	Method	Description
<V extends Serializable> V	get(String sKey)	Get the property of a given key.
protected CacheService	getCacheService()	Return the CacheService used by this executor service.
<V extends Serializable> V	put(String sKey, V value)	Put a property with the given name and value.
void	readExternal(PofReader in)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
void	writeExternal(PofWriter out)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

m_sTaskId

protected String m_sTaskId

The Task ID.

m_service

protected CacheService m_service

The CacheService used by the Task, hence the property cache.

Constructor Details

ClusteredProperties

public ClusteredProperties()

Constructs an ClusteredProperties (required for serialization).

ClusteredProperties

public ClusteredProperties(String sTaskId,
 CacheService service)

Constructs a ClusteredProperties given the task ID and cache service.

Parameters:

sTaskId - the Task ID

service - the CacheService used by the Task

ClusteredProperties

public ClusteredProperties(String sTaskId,
 CacheService service,
 TaskProperties properties)

Constructs a ClusteredProperties given the task ID, cache service, and initial properties.

Parameters:

sTaskId - the Task ID

service - the CacheService used by the Task

properties - the properties to initialize

Method Details

get

public <V extends Serializable> V get(String sKey)

Description copied from interface: Task.Properties

Get the property of a given key.

Specified by:

get in interface Task.Properties

Type Parameters:

V - the value type of the property

Parameters:

sKey - the key of the property

Returns:

the value of the property

put

public <V extends Serializable> V put(String sKey,
 V value)

Description copied from interface: Task.Properties

Put a property with the given name and value.

Specified by:

put in interface Task.Properties

Type Parameters:

V - the value type of the property

Parameters:

sKey - the key of the property

value - the value of the property

Returns:

the previous value of the property or null if it's a new property

readExternal

public void readExternal(DataInput in)
                  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:

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

Throws:

IOException - if an I/O exception occurs

writeExternal

public void writeExternal(DataOutput out)
                   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:

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

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  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:

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

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   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:

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

Throws:

IOException - if an I/O error occurs

getCacheService

protected CacheService getCacheService()

Return the CacheService used by this executor service.

Returns:

the CacheService used by this executor service