de.zmt.params

Class BaseSimParamsNode

java.lang.Object

de.zmt.params.BaseParamDefinition

de.zmt.params.BaseParamsNode

de.zmt.params.BaseSimParamsNode

All Implemented Interfaces:

ParamDefinition, ParamsNode, SimParams, Serializable, sim.portrayal.inspector.ProvidesInspector

public abstract class BaseSimParamsNode
extends BaseParamsNode
implements SimParams, sim.portrayal.inspector.ProvidesInspector

Abstract implementation of a SimParams node. Provides an inspector that gets populated from added definitions. Added definitions are checked against allowed classes that can be specified by implementing classes.

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.zmt.params.SimParams

DEFAULT_FILENAME

Constructor Summary

Constructors

Constructor and Description
BaseSimParamsNode()

Method Summary

Modifier and Type	Method and Description
<T extends ParamDefinition> T	addDefinition(Class<T> definitionClass) Adds a ParamDefinition if allowed internally and to the inspector.
protected abstract boolean	addDefinitionInternal(ParamDefinition definition) Implementing classes need to handle adding an allowed definition here.
protected Set<Class<? extends ParamDefinition>>	getAllowedDefinitionTypes() Returns allowed types which definitions are checked on when added.
protected <T extends ParamDefinition> T	instantiateDefinition(Class<T> definitionClass) Instantiates given ParamDefinition class by calling its default constructor.
Inspector	provideInspector(GUIState state, String name)
boolean	removeDefinition(ParamDefinition definition) Removes a ParamDefinition internally and from inspector if present.
protected abstract boolean	removeDefinitionInternal(ParamDefinition definition) Implementing classes need to handle removing a definition here.
String	toString()

Methods inherited from class de.zmt.params.BaseParamsNode

equals, hashCode

Methods inherited from class de.zmt.params.BaseParamDefinition

hideTitle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.zmt.params.SimParams

getSeed

Methods inherited from interface de.zmt.params.ParamDefinition

accessor, getTitle

Methods inherited from interface de.zmt.params.ParamsNode

getDefinitions

Constructor Detail

BaseSimParamsNode

public BaseSimParamsNode()

Method Detail

instantiateDefinition

protected <T extends ParamDefinition> T instantiateDefinition(Class<T> definitionClass)

Instantiates given ParamDefinition class by calling its default constructor. Only called with allowed types. Implementing classes may override this method, e.g. if a definition must be instantiated with specific parameters.

Parameters:

definitionClass - the ParamDefinition class to be instantiated

Returns:

an instance of the definition

See Also:

getAllowedDefinitionTypes()

addDefinitionInternal

protected abstract boolean addDefinitionInternal(ParamDefinition definition)

Implementing classes need to handle adding an allowed definition here.

Parameters:

definition - the definition

Returns:

true if definition could be added

removeDefinitionInternal

protected abstract boolean removeDefinitionInternal(ParamDefinition definition)

Implementing classes need to handle removing a definition here.

Parameters:

definition - the definition

Returns:

true if definition could be removed

getAllowedDefinitionTypes

protected Set<Class<? extends ParamDefinition>> getAllowedDefinitionTypes()

Returns allowed types which definitions are checked on when added. Default behavior is to not allow any definition. Implementing classes need to specify the types allowed.

Returns:

the set of allowed definition types

addDefinition

public final <T extends ParamDefinition> T addDefinition(Class<T> definitionClass)

Adds a ParamDefinition if allowed internally and to the inspector.

Specified by:

addDefinition in interface SimParams

Parameters:

definitionClass - the Class of the ParamDefinition to be added

Returns:

the added ParamDefinition object

Throws:

IllegalArgumentException - if the definition's type is not allowed

removeDefinition

public final boolean removeDefinition(ParamDefinition definition)

Removes a ParamDefinition internally and from inspector if present.

Specified by:

removeDefinition in interface SimParams

Returns:

true if removal succeeded

provideInspector

public Inspector provideInspector(GUIState state,
                                  String name)

Specified by:

provideInspector in interface sim.portrayal.inspector.ProvidesInspector

toString

public String toString()

Overrides:

toString in class BaseParamDefinition