Class MutableExecutionPlan

java.lang.Object

com.oracle.coherence.concurrent.executor.MutableExecutionPlan

All Implemented Interfaces:

ExecutionPlan, ExternalizableLite, PortableObject, Serializable

public class MutableExecutionPlan
extends Object
implements ExecutionPlan, PortableObject

A mutable implementation of ExecutionPlan.

Since:

21.12

Author:

bo

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.coherence.concurrent.executor.ExecutionPlan

ExecutionPlan.Action

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_cPendingRecoveryCount	The number of effective assignments in the past that failed (for some reason) that can be re-assigned in the future as ExecutionPlan.Action.RECOVER actions.
protected boolean	m_fSatisfied	Indicates when an ExecutionPlan has satisfied the requirements of the defining ExecutionStrategy.
protected LinkedHashMap<String, ExecutionPlan.Action>	m_mapActions	The ExecutionPlan.Actions by Executor identity.

Constructor Summary

Constructors

Constructor	Description
MutableExecutionPlan()	Constructs an empty, unsatisfied MutableExecutionPlan.
MutableExecutionPlan(ExecutionPlan executionPlan)	Constructs a MutableExecutionPlan based on another ExecutionPlan.

Method Summary

Modifier and Type	Method	Description
void	assign(String sId)	Assigns the specified Executor to the Task.
boolean	contains(String sId)	Determines if the ExecutionStrategy contains an ExecutionPlan.Action for the specified Executor.
int	count(Predicate<? super ExecutionPlan.Action> predicate)	Determines the number of a Executors whose ExecutionPlan.Actions satisfy the specified Predicate in the ExecutionPlan.
boolean	equals(Object other)
ExecutionPlan.Action	getAction(String sId)	Obtains the proposed ExecutionPlan.Action for the specified Executor.
Iterator<String>	getIds()	Obtains the unique identities of Executors with ExecutionPlan.Actions.
int	getPendingRecoveryCount()	Determines the current number of effective assignments of a Task to Executors that failed (for some reason), which could be re-assigned as a ExecutionPlan.Action.RECOVER action.
int	hashCode()
boolean	isSatisfied()	Determines if the ExecutionPlan will satisfy the ExecutionStrategy conditions, including assigning the required number of Executors to a Task for execution.
boolean	optimize()	Optimizes the ExecutionPlan, returning if there where any changes caused by the optimization.
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	recover(String sId)	Assigns the specified Executor to the Task (for recovery).
void	release(String sId)	Releases the specified Executor for the Task.
boolean	setAction(String sId, ExecutionPlan.Action action)	Sets the proposed ExecutionPlan.Action for the specified Executor.
void	setPendingRecoveryCount(int cPendingRecoveryCount)	Sets the number of recovery operations that should occur.
void	setSatisfied(boolean fSatisfied)	Sets if the ExecutionPlan is satisfied.
int	size()	Obtains the number of ExecutionPlan.Actions for the ExecutionPlan.
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 Details

m_mapActions

protected LinkedHashMap<String, ExecutionPlan.Action> m_mapActions

The ExecutionPlan.Actions by Executor identity.

m_fSatisfied

protected boolean m_fSatisfied

Indicates when an ExecutionPlan has satisfied the requirements of the defining ExecutionStrategy.

m_cPendingRecoveryCount

protected int m_cPendingRecoveryCount

The number of effective assignments in the past that failed (for some reason) that can be re-assigned in the future as ExecutionPlan.Action.RECOVER actions.

Constructor Details

MutableExecutionPlan

public MutableExecutionPlan()

Constructs an empty, unsatisfied MutableExecutionPlan.

MutableExecutionPlan

public MutableExecutionPlan(ExecutionPlan executionPlan)

Constructs a MutableExecutionPlan based on another ExecutionPlan.

Parameters:

executionPlan - the ExecutionPlan

Method Details

setPendingRecoveryCount

public void setPendingRecoveryCount(int cPendingRecoveryCount)

Sets the number of recovery operations that should occur.

Parameters:

cPendingRecoveryCount - see getPendingRecoveryCount()

assign

public void assign(String sId)

Assigns the specified Executor to the Task.

Parameters:

sId - the identity of the Executor

recover

public void recover(String sId)

Assigns the specified Executor to the Task (for recovery).

Parameters:

sId - the identity of the Executor

release

public void release(String sId)

Releases the specified Executor for the Task.

Parameters:

sId - the identity of the Executor

contains

public boolean contains(String sId)

Determines if the ExecutionStrategy contains an ExecutionPlan.Action for the specified Executor.

Parameters:

sId - the identity of the Executor

Returns:

true if the ExecutionStrategy contains an ExecutionPlan.Action for the specified Executor, false otherwise

setSatisfied

public void setSatisfied(boolean fSatisfied)

Sets if the ExecutionPlan is satisfied.

Parameters:

fSatisfied - is satisfied

getAction

public ExecutionPlan.Action getAction(String sId)

Description copied from interface: ExecutionPlan

Obtains the proposed ExecutionPlan.Action for the specified Executor.

Specified by:

getAction in interface ExecutionPlan

Parameters:

sId - the Executor id

Returns:

an ExecutionPlan.Action or null if no ExecutionPlan.Action has been defined

setAction

public boolean setAction(String sId,
 ExecutionPlan.Action action)

Description copied from interface: ExecutionPlan

Sets the proposed ExecutionPlan.Action for the specified Executor.

Specified by:

setAction in interface ExecutionPlan

Parameters:

sId - the Executor id

action - the ExecutionPlan.Action to set to

Returns:

a boolean to indicate if the ExecutionPlan was changed as a result of setting an action

size

public int size()

Description copied from interface: ExecutionPlan

Obtains the number of ExecutionPlan.Actions for the ExecutionPlan.

Specified by:

size in interface ExecutionPlan

Returns:

the number of ExecutionPlan.Actions

count

public int count(Predicate<? super ExecutionPlan.Action> predicate)

Description copied from interface: ExecutionPlan

Determines the number of a Executors whose ExecutionPlan.Actions satisfy the specified Predicate in the ExecutionPlan.

Specified by:

count in interface ExecutionPlan

Parameters:

predicate - the Predicate to evaluate the ExecutionPlan.Action

Returns:

the number of Executors that satisfy the specified Predicate

isSatisfied

public boolean isSatisfied()

Description copied from interface: ExecutionPlan

Determines if the ExecutionPlan will satisfy the ExecutionStrategy conditions, including assigning the required number of Executors to a Task for execution.

Specified by:

isSatisfied in interface ExecutionPlan

Returns:

true when the ExecutionPlan satisfies the ExecutionStrategy that defined it false otherwise

getPendingRecoveryCount

public int getPendingRecoveryCount()

Description copied from interface: ExecutionPlan

Determines the current number of effective assignments of a Task to Executors that failed (for some reason), which could be re-assigned as a ExecutionPlan.Action.RECOVER action.

Specified by:

getPendingRecoveryCount in interface ExecutionPlan

Returns:

the pending recovery count

optimize

public boolean optimize()

Description copied from interface: ExecutionPlan

Optimizes the ExecutionPlan, returning if there where any changes caused by the optimization.

Specified by:

optimize in interface ExecutionPlan

Returns:

true if the ExecutionPlan was changed during optimization, false otherwise

getIds

public Iterator<String> getIds()

Description copied from interface: ExecutionPlan

Obtains the unique identities of Executors with ExecutionPlan.Actions.

Specified by:

getIds in interface ExecutionPlan

Returns:

the Executor identities.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode 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

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