eu.cqse.check.framework.typetracker

Class TypedVariable

java.lang.Object

eu.cqse.check.framework.typetracker.TypedVariable

All Implemented Interfaces:

java.io.Serializable

public class TypedVariable
extends java.lang.Object
implements java.io.Serializable

A typed variable is an immutable object that contains information about the type of a variable. It stores the variable's name, the variable's type and further modifiers. The type is stored as string, that represents the concatenation of all contained token texts. Thus for field private static java.util.List<String> names; the variable name "names", the modifiers ["private", "static"] and the type name "java.util.List<String>" will be stored.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNKNOWN_TYPE_NAME Type name that is used if no type name was given.

Constructor Summary

Constructors

Constructor and Description
TypedVariable(java.lang.String variableName, java.lang.String typeName, java.util.List<IToken> modifiers, ShallowEntity definitionEntity) Creates a new type info object, the variable name and the modifier list must not be null.

Method Summary

Modifier and Type	Method and Description
ShallowEntity	getDeclaringEntity() Returns the entity that declares this variable.
java.util.List<IToken>	getModifiers() Returns an unmodifiable list of variable modifiers.
java.lang.String	getTypeName() Returns the variable's type name.
java.lang.String	getVariableName() Returns the variable's name.
boolean	hasModifier(ETokenType modifierType) Returns whether this type info contains the given modifier.
java.lang.String	toString() Creates string representation of the type info object.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_TYPE_NAME

public static final java.lang.String UNKNOWN_TYPE_NAME

Type name that is used if no type name was given.

See Also:

Constant Field Values

Constructor Detail

TypedVariable

public TypedVariable(java.lang.String variableName,
                     java.lang.String typeName,
                     java.util.List<IToken> modifiers,
                     ShallowEntity definitionEntity)

Creates a new type info object, the variable name and the modifier list must not be null.

Method Detail

getVariableName

public java.lang.String getVariableName()

Returns the variable's name.

getTypeName

public java.lang.String getTypeName()

Returns the variable's type name.

hasModifier

public boolean hasModifier(ETokenType modifierType)

Returns whether this type info contains the given modifier.

getModifiers

public java.util.List<IToken> getModifiers()

Returns an unmodifiable list of variable modifiers.

getDeclaringEntity

public ShallowEntity getDeclaringEntity()

Returns the entity that declares this variable.

toString

public java.lang.String toString()

Creates string representation of the type info object.

Overrides:

toString in class java.lang.Object