Package adams.flow.container

Class EncapsulatedActorsContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.EncapsulatedActorsContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

public class EncapsulatedActorsContainer
extends AbstractContainer

Container for encapsulating actors alongside variables and storage items.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

ActorProcessor, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_ACTOR	the key for the actor.
static String	VALUE_INPUT	the key for the input.
static String	VALUE_INPUTNAME	the key for the input name.
static String	VALUE_OUTPUT	the key for the output.
static String	VALUE_OUTPUTNAME	the key for the output name.
static String	VALUE_STORAGE	the key for the storage.
static String	VALUE_VARIABLES	the key for the variables.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
EncapsulatedActorsContainer()	Default constructor.
EncapsulatedActorsContainer(Actor actor, Variables variables, Storage storage)	Initializes the container with the actors, variables and storage.
EncapsulatedActorsContainer(Actor actor, Variables variables, Storage storage, Object input, StorageName inputName)	Initializes the container with the actors, variables and storage.
EncapsulatedActorsContainer(Actor actor, Variables variables, Storage storage, Object input, StorageName inputName, Object output, StorageName outputName)	Initializes the container with the actors, variables and storage.

Method Summary

Modifier and Type	Method	Description
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALUE_ACTOR

public static final String VALUE_ACTOR

the key for the actor.

See Also:

Constant Field Values

VALUE_VARIABLES

public static final String VALUE_VARIABLES

the key for the variables.

See Also:

Constant Field Values

VALUE_STORAGE

public static final String VALUE_STORAGE

the key for the storage.

See Also:

Constant Field Values

VALUE_INPUT

public static final String VALUE_INPUT

the key for the input.

See Also:

Constant Field Values

VALUE_INPUTNAME

public static final String VALUE_INPUTNAME

the key for the input name.

See Also:

Constant Field Values

VALUE_OUTPUT

public static final String VALUE_OUTPUT

the key for the output.

See Also:

Constant Field Values

VALUE_OUTPUTNAME

public static final String VALUE_OUTPUTNAME

the key for the output name.

See Also:

Constant Field Values

Constructor Detail

EncapsulatedActorsContainer

public EncapsulatedActorsContainer()

Default constructor.

EncapsulatedActorsContainer

public EncapsulatedActorsContainer(Actor actor,
                                   Variables variables,
                                   Storage storage)

Initializes the container with the actors, variables and storage.

Parameters:

actor - the actor to store

variables - the variables to store

storage - the storage items to store

EncapsulatedActorsContainer

public EncapsulatedActorsContainer(Actor actor,
                                   Variables variables,
                                   Storage storage,
                                   Object input,
                                   StorageName inputName)

Initializes the container with the actors, variables and storage.

Parameters:

actor - the actor to store

variables - the variables to store

storage - the storage items to store

input - the input token payload, can be null

inputName - the input name in storage, can be null

EncapsulatedActorsContainer

public EncapsulatedActorsContainer(Actor actor,
                                   Variables variables,
                                   Storage storage,
                                   Object input,
                                   StorageName inputName,
                                   Object output,
                                   StorageName outputName)

Initializes the container with the actors, variables and storage.

Parameters:

actor - the actor to store

variables - the variables to store

storage - the storage items to store

input - the input token payload, can be null

inputName - the input name in storage, can be null

output - the output, can be null

outputName - the output name in storage, can be null

Method Detail

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface Container

Specified by:

names in class AbstractContainer

Returns:

iterator over all possible value names

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface Container

Specified by:

isValid in class AbstractContainer

Returns:

true if all the necessary values are available