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

Class Description

java.lang.Object

com.oracle.coherence.concurrent.executor.options.Description

All Implemented Interfaces:

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

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

An TaskExecutorService.Registration.Option to specify the Description of a registered ExecutorService. This option shouldn't be used for targeting tasks.

Since:

21.12

Author:

rl 11.12.2021

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_sDescription	The details of the executor.
static Description	UNKNOWN	The description to use when no description has been provided.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Description()	Constructs a Description (required for serialization).
protected	Description(String sDescription)	Constructs a Description object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
String	getName()	Obtains the the Description.
int	hashCode()
static Description	of(String sDescription)	Obtains a Description based on the provided argument.
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

UNKNOWN

public static Description UNKNOWN

The description to use when no description has been provided.

m_sDescription

protected String m_sDescription

The details of the executor.

Constructor Detail

Description

public Description()

Constructs a Description (required for serialization).

Description

protected Description(String sDescription)

Constructs a Description object.

Parameters:

sDescription - the description of the executor

Method Detail

getName

public String getName()

Obtains the the Description.

Returns:

a Description

of

public static Description of(String sDescription)

Obtains a Description based on the provided argument.

Parameters:

sDescription - the description

Returns:

a Description

equals

public boolean equals(Object object)

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(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