Package modelarium.entities.attributes.sets.readonly

Class ReadOnlyAgentAttributeSet

java.lang.Object

modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

modelarium.entities.attributes.sets.readonly.ReadOnlyAgentAttributeSet

public final class ReadOnlyAgentAttributeSet
extends ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

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

This class specialises ReadOnlyAttributeSet so that retrieved attributes are returned as deep clones of their agent-flavoured types.

Constructor Summary

Constructors

Constructor	Description
ReadOnlyAgentAttributeSet(AgentAttributeSet attributeSet)	Constructs a new immutable agent attribute set wrapping the specified mutable attribute set.

Method Summary

Modifier and Type	Method	Description
AgentAttribute	get(int index)	Retrieves a deep clone of a publicly accessible attribute by index.
AgentAttribute	get(String attributeName)	Retrieves a deep clone of a publicly accessible attribute by name.
AgentEvent	getEvent(int eventIndex)	Retrieves a deep clone of an event by its index among the wrapped set's events.
AgentEvent	getEvent(String eventName)	Retrieves a deep clone of an event by name.
AgentProperty<?>	getProperty(int propertyIndex)	Retrieves a deep clone of a property by its index among the wrapped set's properties.
AgentProperty<?>	getProperty(String propertyName)	Retrieves a deep clone of a property by name.
AgentRoutine	getRoutine(int routineIndex)	Retrieves a deep clone of a routine by its index among the wrapped set's routines.
AgentRoutine	getRoutine(String routineName)	Retrieves a deep clone of a routine by name.

Methods inherited from class modelarium.entities.attributes.sets.readonly.ReadOnlyAttributeSet

getLog, name, size

Methods inherited from class java.lang.Object

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

Constructor Details

ReadOnlyAgentAttributeSet

public ReadOnlyAgentAttributeSet(AgentAttributeSet attributeSet)

Constructs a new immutable agent attribute set wrapping the specified mutable attribute set.

Parameters:

attributeSet - the mutable agent attribute set to provide a read-only view of

Method Details

get

public AgentAttribute get(int index)

Retrieves a deep clone of a publicly accessible attribute by index.

Specified by:

get in class ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

Parameters:

index - the index of the attribute to retrieve

Returns:

a deep clone of the AgentAttribute at the specified index

get

public AgentAttribute get(String attributeName)

Retrieves a deep clone of a publicly accessible attribute by name.

Specified by:

get in class ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

Parameters:

attributeName - the name of the attribute to retrieve

Returns:

a deep clone of the AgentAttribute with the specified name

getEvent

public AgentEvent getEvent(int eventIndex)

Retrieves a deep clone of an event by its index among the wrapped set's events.

Specified by:

getEvent in class ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

Parameters:

eventIndex - the index of the event to retrieve

Returns:

a deep clone of the AgentEvent at the specified index

getEvent

public AgentEvent getEvent(String eventName)

Retrieves a deep clone of an event by name.

Specified by:

getEvent in class ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

Parameters:

eventName - the name of the event to retrieve

Returns:

a deep clone of the AgentEvent with the specified name

getRoutine

public AgentRoutine getRoutine(int routineIndex)

Retrieves a deep clone of a routine by its index among the wrapped set's routines.

Specified by:

getRoutine in class ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

Parameters:

routineIndex - the index of the routine to retrieve

Returns:

a deep clone of the AgentRoutine at the specified index

getRoutine

public AgentRoutine getRoutine(String routineName)

Retrieves a deep clone of a routine by name.

Specified by:

getRoutine in class ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

Parameters:

routineName - the name of the routine to retrieve

Returns:

a deep clone of the AgentRoutine with the specified name

getProperty

public AgentProperty<?> getProperty(int propertyIndex)

Retrieves a deep clone of a property by its index among the wrapped set's properties.

Specified by:

getProperty in class ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

Parameters:

propertyIndex - the index of the property to retrieve

Returns:

a deep clone of the AgentProperty at the specified index

getProperty

public AgentProperty<?> getProperty(String propertyName)

Retrieves a deep clone of a property by name.

Specified by:

getProperty in class ReadOnlyAttributeSet<AgentSimulationContext,AgentContext>

Parameters:

propertyName - the name of the property to retrieve

Returns:

a deep clone of the AgentProperty with the specified name