desmoj.extensions.experimentation.reflect

Class FieldAccessPoint

java.lang.Object

desmoj.extensions.experimentation.reflect.FieldAccessPoint

All Implemented Interfaces:

AccessPoint

Direct Known Subclasses:

MutableFieldAccessPoint

public class FieldAccessPoint
extends java.lang.Object
implements AccessPoint

An AccessPoint for an attribute (field) of a class. This pattern can be found in several frameworks for agent- or component-based simulation (e.g. 'Probes' in Swarm - see www.swarm.org). The term 'access point' was adopted from the dissertation "Ein flexibler, CORBA-basierter Ansatz fuer die verteilte, komponentenorientierte Simulation" by Ralf Bachmann (2003).

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Author:

Ruth Meyer, Nicolas Knaak

Constructor Summary

Constructors

Constructor and Description
FieldAccessPoint(java.lang.reflect.Field inspectableField, java.lang.Object accessed) constructs an access point object from the given field and object.
FieldAccessPoint(java.lang.String name, java.lang.reflect.Field inspectableField, java.lang.Object inspected) constructs an access point object from the given field and object.
FieldAccessPoint(java.lang.String fieldName, java.lang.Object accessed) constructs an access point object for the specified field name and the given declaring object.
FieldAccessPoint(java.lang.String name, java.lang.String fieldName, java.lang.Object accessed) constructs an access point object for the specified field name and the given declaring object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldName()
java.lang.String	getName() returns the name of this AccessPoint.
java.lang.Object	getValue() returns the current value of the attribute referenced by this access point.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldAccessPoint

public FieldAccessPoint(java.lang.String fieldName,
                        java.lang.Object accessed)

constructs an access point object for the specified field name and the given declaring object. The parameter fieldName must denote a field declared in the class of declaringObject or inherited from one of its superclasses.

Parameters:

fieldName - the name of the field to be inspected

accessed - the object whose field values are to be inspected

FieldAccessPoint

public FieldAccessPoint(java.lang.reflect.Field inspectableField,
                        java.lang.Object accessed)

constructs an access point object from the given field and object. The parameter inspectableField must reference a field declared in the class of declaringObject or inherited from one of its superclasses.

Parameters:

inspectableField - the field to be inspected

accessed - the accessed object

FieldAccessPoint

public FieldAccessPoint(java.lang.String name,
                        java.lang.String fieldName,
                        java.lang.Object accessed)
                 throws ReflectException

constructs an access point object for the specified field name and the given declaring object. The parameter fieldName must denote a field declared in the class of declaringObject or inherited from one of its superclasses. The name of the access point may differ from the field name.

Parameters:

name - the name for this access point

fieldName - the name of the field to be inspected

accessed - the object whose field values are to be inspected

Throws:

ReflectException

FieldAccessPoint

public FieldAccessPoint(java.lang.String name,
                        java.lang.reflect.Field inspectableField,
                        java.lang.Object inspected)

constructs an access point object from the given field and object. The parameter inspectableField must reference a field declared in the class of declaringObject or inherited from one of its superclasses. The name of the access point may differ from the field's name.

Parameters:

name - the name for this access point

inspectableField - the field to be inspected

inspected - the inspected object

Method Detail

getValue

public java.lang.Object getValue()
                          throws ReflectException

Description copied from interface: AccessPoint

returns the current value of the attribute referenced by this access point.

Specified by:

getValue in interface AccessPoint

Returns:

the current value of the accessed field for the declaring object.

Throws:

ReflectException

getName

public java.lang.String getName()

Description copied from interface: AccessPoint

returns the name of this AccessPoint.

Specified by:

getName in interface AccessPoint

Returns:

the name of this field access point.

getFieldName

public java.lang.String getFieldName()

Returns:

the name of the inspectable field.