Package net.ssehub.easy.instantiation.core.model.vilTypes.configuration

Class AbstractIvmlFieldDescriptor

java.lang.Object

net.ssehub.easy.instantiation.core.model.vilTypes.FieldDescriptor

net.ssehub.easy.instantiation.core.model.vilTypes.configuration.AbstractIvmlFieldDescriptor

All Implemented Interfaces:

IMetaField

Direct Known Subclasses:

IvmlAccessorFieldDescriptor, IvmlAnnotationFieldDescriptor, IvmlConfigurationFieldDescriptor

public abstract class AbstractIvmlFieldDescriptor
extends FieldDescriptor

Implements the common capabilities for an IVML read-only field descriptor.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractVariable	var

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	AbstractIvmlFieldDescriptor()	Constructor for serialization.
protected	AbstractIvmlFieldDescriptor(TypeDescriptor<?> declaringType, AbstractVariable var, TypeRegistry registry)	Creates the field descriptor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getJavaSignature()	Returns the java-like signature of this operation.
TypeDescriptor<?>	getMetaType()	Returns the type to resolve operations on the field itself, e.g., whether the underlying decision variable is defined.
protected java.lang.Object	getSpecificBaseValue(AbstractIvmlVariable tmp)	Returns the specific base value according to the decision variable access functions.
protected AbstractVariable	getVariable()	Returns the underlying IVML variable.
boolean	isReadOnly()	Returns whether the field is read-only.
boolean	isStatic()	Returns whether the field is static.

Methods inherited from class net.ssehub.easy.instantiation.core.model.vilTypes.FieldDescriptor

getDeclaringType, getMetaValue, getName, getSignature, getType, getValue, setValue

Methods inherited from class java.lang.Object

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

Field Detail

var

private AbstractVariable var

Constructor Detail

AbstractIvmlFieldDescriptor

AbstractIvmlFieldDescriptor()

Constructor for serialization.

AbstractIvmlFieldDescriptor

protected AbstractIvmlFieldDescriptor(TypeDescriptor<?> declaringType,
                                      AbstractVariable var,
                                      TypeRegistry registry)
                               throws VilException

Creates the field descriptor.

Parameters:

declaringType - the declaring type

var - the variable to create the descriptor for

registry - the actual type registry

Throws:

VilException - in case that creating the descriptor fails

Method Detail

getVariable

protected AbstractVariable getVariable()

Returns the underlying IVML variable.

Returns:

the underlying variable

getJavaSignature

public java.lang.String getJavaSignature()

Description copied from interface: IMetaField

Returns the java-like signature of this operation.

Returns:

the java-like Java signature of this operation

isReadOnly

public boolean isReadOnly()

Description copied from interface: IMetaField

Returns whether the field is read-only. Please note that this method provides a "static" information, i.e., it cannot change during script execution. If a field can be modified at all, this method shall return true and determine when the value is changed, whether the actual access is permitted. In contrast, if it is known that the field cannot be changed at all, this method shall return false.

Returns:

true if the field is read-only, false else

isStatic

public boolean isStatic()

Description copied from interface: IMetaField

Returns whether the field is static.

Returns:

true if the field is static, false else

getMetaType

public TypeDescriptor<?> getMetaType()

Description copied from class: FieldDescriptor

Returns the type to resolve operations on the field itself, e.g., whether the underlying decision variable is defined. A field must not return a type (null, in particular if IMetaField.isStatic()). If not null, this class must return a valid value in FieldDescriptor.getMetaValue(Object).

Overrides:

getMetaType in class FieldDescriptor

Returns:

null

getSpecificBaseValue

protected java.lang.Object getSpecificBaseValue(AbstractIvmlVariable tmp)

Returns the specific base value according to the decision variable access functions.

Parameters:

tmp - the decision variable

Returns:

the specific base value, null if not possible