Package com.oracle.coherence.concurrent.executor.options

Class Storage

java.lang.Object

com.oracle.coherence.concurrent.executor.options.Storage

All Implemented Interfaces:

com.oracle.coherence.concurrent.executor.TaskExecutorService.Registration.Option, ExternalizableLite, PortableObject, Serializable

public class Storage
extends Object
implements com.oracle.coherence.concurrent.executor.TaskExecutorService.Registration.Option, PortableObject

An TaskExecutorService.Registration.Option to specify whether an Executor is running on a storage enabled Coherence server.

See DistributedCacheService.isLocalStorageEnabled()

Since:

21.12

Author:

phf

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static Storage	DISABLED	Read-only Storage set to disabled.
protected static Storage	ENABLED	Read-only Storage set to enabled.
protected boolean	m_fStorageEnabled	Whether the Coherence server in which the Executor is running is storage enabled.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Storage()	Constructs a Storage (required for serialization).
protected	Storage(boolean fStorageEnabled)	Constructs a Storage.

Method Summary

Modifier and Type	Method	Description
static Storage	disabled()	Return a Storage disabled TaskExecutorService.Registration.Option.
static Storage	enabled()	Return a Storage enabled TaskExecutorService.Registration.Option.
static Storage	enabled(boolean fStorageEnabled)	Return a Storage TaskExecutorService.Registration.Option.
boolean	equals(Object obj)
int	hashCode()
boolean	isEnabled()	Return whether the Coherence server in which the Executor is running is storage enabled.
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.
String	toString()
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ENABLED

protected static final Storage ENABLED

Read-only Storage set to enabled.

DISABLED

protected static final Storage DISABLED

Read-only Storage set to disabled.

m_fStorageEnabled

protected boolean m_fStorageEnabled

Whether the Coherence server in which the Executor is running is storage enabled.

Constructor Detail

Storage

public Storage()

Constructs a Storage (required for serialization).

Storage

protected Storage(boolean fStorageEnabled)

Constructs a Storage.

Parameters:

fStorageEnabled - whether the Coherence server in which the Executor is running is storage enabled.

Method Detail

isEnabled

public boolean isEnabled()

Return whether the Coherence server in which the Executor is running is storage enabled.

Returns:

whether the Coherence server in which the Executor is running is storage enabled

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

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

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

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

enabled

public static Storage enabled(boolean fStorageEnabled)

Return a Storage TaskExecutorService.Registration.Option.

Parameters:

fStorageEnabled - whether the Option represents enabled (true), or disabled (false)

Returns:

a Storage TaskExecutorService.Registration.Option

enabled

public static Storage enabled()

Return a Storage enabled TaskExecutorService.Registration.Option.

Returns:

a Storage TaskExecutorService.Registration.Option

disabled

public static Storage disabled()

Return a Storage disabled TaskExecutorService.Registration.Option.

Returns:

a Storage TaskExecutorService.Registration.Option