Package modelarium.entities.readonly

Class ReadOnlyEnvironment

java.lang.Object

modelarium.entities.readonly.ReadOnlyEntity<EnvironmentSimulationContext,EnvironmentContext,EnvironmentAttributeSet,AttributeSetLog<EnvironmentSimulationContext>>

modelarium.entities.readonly.ReadOnlyEnvironment

public final class ReadOnlyEnvironment
extends ReadOnlyEntity<EnvironmentSimulationContext,EnvironmentContext,EnvironmentAttributeSet,AttributeSetLog<EnvironmentSimulationContext>>

Class for providing a read-only view of an Environment.

This class wraps the mutable environment so that other model elements can inspect it without being able to modify it.

Constructor Summary

Constructors

Constructor	Description
ReadOnlyEnvironment(Environment entity)	Constructs a new immutable environment wrapping the specified mutable environment.

Method Summary

Modifier and Type	Method	Description
ReadOnlyEnvironmentAttributeSet	getAttributeSet(int attributeSetIndex)	Retrieves a read-only view of one of the wrapped environment's attribute sets by index.
ReadOnlyEnvironmentAttributeSet	getAttributeSet(String attributeSetName)	Retrieves a read-only view of one of the wrapped environment's attribute sets by name.
ReadOnlyEvent	getEvent(String attributeSetName, String eventName)	Retrieves a read-only view of an event attribute from one of the wrapped environment's attribute sets.
ReadOnlyProperty<?>	getProperty(String attributeSetName, String propertyName)	Retrieves a read-only view of a property attribute from one of the wrapped environment's attribute sets.
ReadOnlyRoutine	getRoutine(String attributeSetName, String routineName)	Retrieves a read-only view of a routine attribute from one of the wrapped environment's attribute sets.

Methods inherited from class modelarium.entities.readonly.ReadOnlyEntity

attributeCount, attributeSetCount, getLog, getMutableEntity, name

Methods inherited from class java.lang.Object

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

Constructor Details

ReadOnlyEnvironment

public ReadOnlyEnvironment(Environment entity)

Constructs a new immutable environment wrapping the specified mutable environment.

Parameters:

entity - the mutable environment to provide a read-only view of

Method Details

getAttributeSet

public ReadOnlyEnvironmentAttributeSet getAttributeSet(int attributeSetIndex)

Retrieves a read-only view of one of the wrapped environment's attribute sets by index.

Specified by:

getAttributeSet in class ReadOnlyEntity<EnvironmentSimulationContext,EnvironmentContext,EnvironmentAttributeSet,AttributeSetLog<EnvironmentSimulationContext>>

Parameters:

attributeSetIndex - the index of the attribute set to retrieve

Returns:

a new ReadOnlyEnvironmentAttributeSet instance wrapping the attribute set at the specified index

getAttributeSet

public ReadOnlyEnvironmentAttributeSet getAttributeSet(String attributeSetName)

Retrieves a read-only view of one of the wrapped environment's attribute sets by name.

Specified by:

getAttributeSet in class ReadOnlyEntity<EnvironmentSimulationContext,EnvironmentContext,EnvironmentAttributeSet,AttributeSetLog<EnvironmentSimulationContext>>

Parameters:

attributeSetName - the name of the attribute set to retrieve

Returns:

a new ReadOnlyEnvironmentAttributeSet instance wrapping the attribute set with the specified name

getEvent

public ReadOnlyEvent getEvent(String attributeSetName,
 String eventName)

Retrieves a read-only view of an event attribute from one of the wrapped environment's attribute sets.

Parameters:

attributeSetName - the name of the attribute set containing the event

eventName - the name of the event to retrieve

Returns:

the ReadOnlyEvent with the specified name

getRoutine

public ReadOnlyRoutine getRoutine(String attributeSetName,
 String routineName)

Retrieves a read-only view of a routine attribute from one of the wrapped environment's attribute sets.

Parameters:

attributeSetName - the name of the attribute set containing the routine

routineName - the name of the routine to retrieve

Returns:

the ReadOnlyRoutine with the specified name

getProperty

public ReadOnlyProperty<?> getProperty(String attributeSetName,
 String propertyName)

Retrieves a read-only view of a property attribute from one of the wrapped environment's attribute sets.

Parameters:

attributeSetName - the name of the attribute set containing the property

propertyName - the name of the property to retrieve

Returns:

the ReadOnlyProperty with the specified name