IfStorageValue.IfStorageValueDirector (adams-pom 24.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.flow.control.AbstractDirector
  - - adams.flow.control.IfStorageValue.IfStorageValueDirector

All Implemented Interfaces:

CleanUpHandler, LoggingSupporter, SizeOfHandler, Stoppable, StoppableWithFeedback, FlowPauseStateListener, Serializable

Enclosing class:

IfStorageValue
```
public static class IfStorageValue.IfStorageValueDirector
extends AbstractDirector
```
A specialized director for an IfStorageValue control actor.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Object m_StoredValue
the stored value.
- Fields inherited from class adams.flow.control.AbstractDirector
  m_ControlActor, m_Flushing, m_LoggingPrefix, m_Paused, m_Stopped, m_Stopping
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

IfStorageValueDirector()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cleanUp()`	Cleans up data structures, frees up memory.
`protected boolean`	`doThen()`	Determines whether to execute the 'then' branch.
`String`	`execute()`	Executes the group of actors.
`void`	`setControlActor(AbstractDirectedControlActor value)`	Sets the group to execute.
`protected void`	`setIfThenElseActor(AbstractDirectedControlActor value)`	Calls the super implementation of setControlActor.

Methods inherited from class adams.flow.control.AbstractDirector
configureLogger, flowPauseStateChanged, flushExecution, getControlActor, getVariables, handleException, hasControlActor, initialize, isFinished, isFlushing, isPaused, isStopped, isStopping, pause, pauseExecution, setControlActor, setLoggingLevel, stopExecution, toString, updatePrefix

Methods inherited from class adams.core.logging.LoggingObject
getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_StoredValue
```
protected Object m_StoredValue
```
    the stored value.
- Constructor Detail
  - IfStorageValueDirector
```
public IfStorageValueDirector()
```
- Method Detail
  - setIfThenElseActor
```
protected void setIfThenElseActor(AbstractDirectedControlActor value)
```
    Calls the super implementation of setControlActor.
    
    Parameters:
    
    value - the control actor to set
  - setControlActor
```
public void setControlActor(AbstractDirectedControlActor value)
```
    Sets the group to execute.
    
    Parameters:
    
    value - the group
  - doThen
```
protected boolean doThen()
```
    Determines whether to execute the 'then' branch.
    
    Returns:
    
    true if the 'then' branch should get executed
  - execute
```
public String execute()
```
    Executes the group of actors.
    
    Specified by:
    
    execute in class AbstractDirector
    
    Returns:
    
    null if everything went smooth
  - cleanUp
```
public void cleanUp()
```
    Cleans up data structures, frees up memory.
    
    Specified by:
    
    cleanUp in interface CleanUpHandler
    
    Overrides:
    
    cleanUp in class AbstractDirector