de.uka.ilkd.key.java.declaration

Class VariableDeclaration

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

de.uka.ilkd.key.java.JavaProgramElement

de.uka.ilkd.key.java.JavaNonTerminalProgramElement

de.uka.ilkd.key.java.declaration.JavaDeclaration

de.uka.ilkd.key.java.declaration.VariableDeclaration

All Implemented Interfaces:

Declaration, ModelElement, NonTerminalProgramElement, ProgramElement, TypeReferenceContainer, SourceElement, SVSubstitute

Direct Known Subclasses:

FieldDeclaration, LocalVariableDeclaration, ParameterDeclaration

public abstract class VariableDeclaration
extends JavaDeclaration
implements TypeReferenceContainer

Variable declaration. taken from COMPOST and changed to achieve an immutable structure

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	parentIsInterfaceDeclaration this field stores if parent is an InterfaceDeclaration because we will be unable to walk the tree upwards to check this
protected TypeReference	typeReference Type reference.

Fields inherited from class de.uka.ilkd.key.java.declaration.JavaDeclaration

modArray

Constructor Summary

Constructors

Constructor and Description
VariableDeclaration() Variable declaration.
VariableDeclaration(ExtList children, boolean parentIsInterfaceDeclaration) Variable declaration.
VariableDeclaration(ImmutableArray<Modifier> mods, TypeReference typeRef, boolean parentIsInterfaceDeclaration) Variable declaration.
VariableDeclaration(Modifier[] mods, TypeReference typeRef, boolean parentIsInterfaceDeclaration) Variable declaration.

Method Summary

Modifier and Type	Method and Description
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
SourceElement	getFirstElementIncludingBlocks() Finds the source element that occurs first in the source.
SourceElement	getLastElement() Finds the source element that occurs last in the source.
TypeReference	getTypeReference() Get type reference.
TypeReference	getTypeReferenceAt(int index)
int	getTypeReferenceCount() Get the number of type references in this container.
abstract ImmutableArray<? extends VariableSpecification>	getVariables() Get variables.
boolean	isFinal() Test whether the declaration is final.
boolean	parentIsInterfaceDeclaration() this field stores if parent is an InterfaceDeclaration because we will be unable to walk the tree upwards to check this
void	prettyPrint(PrettyPrinter p) Pretty printing the source element.
void	visit(Visitor v) calls the corresponding method of a visitor in order to perform some action/transformation on this element

Methods inherited from class de.uka.ilkd.key.java.declaration.JavaDeclaration

getModifiers, getStateCount, getVisibilityModifier, isAbstract, isGhost, isModel, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictFp, isSynchronized, isTransient, isVolatile

Methods inherited from class de.uka.ilkd.key.java.JavaNonTerminalProgramElement

compatibleBlockSize, computeHashCode, equals, equalsModRenaming, getArrayPos, match, matchChildren

Methods inherited from class de.uka.ilkd.key.java.JavaProgramElement

getComments, hashCode, prettyPrintMain, reuseSignature

Methods inherited from class de.uka.ilkd.key.java.JavaSourceElement

getEndPosition, getParentClass, getPositionInfo, getRelativePosition, getStartPosition, setParentClass, toSource, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.uka.ilkd.key.java.NonTerminalProgramElement

getChildAt, getChildCount

Methods inherited from interface de.uka.ilkd.key.java.ProgramElement

getComments, match

Methods inherited from interface de.uka.ilkd.key.java.SourceElement

equalsModRenaming, getEndPosition, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

typeReference

protected final TypeReference typeReference

Type reference.

parentIsInterfaceDeclaration

protected final boolean parentIsInterfaceDeclaration

this field stores if parent is an InterfaceDeclaration because we will be unable to walk the tree upwards to check this

Constructor Detail

VariableDeclaration

public VariableDeclaration()

Variable declaration.

VariableDeclaration

public VariableDeclaration(Modifier[] mods,
                           TypeReference typeRef,
                           boolean parentIsInterfaceDeclaration)

Variable declaration.

Parameters:

mods - a modifier mutable list.

typeRef - a type reference.

parentIsInterfaceDeclaration - a boolean set true iff the parent is an InterfaceDeclaration

VariableDeclaration

public VariableDeclaration(ImmutableArray<Modifier> mods,
                           TypeReference typeRef,
                           boolean parentIsInterfaceDeclaration)

Variable declaration.

Parameters:

mods - a modifier immutable list.

typeRef - a type reference.

parentIsInterfaceDeclaration - a boolean set true iff the parent is an InterfaceDeclaration

VariableDeclaration

public VariableDeclaration(ExtList children,
                           boolean parentIsInterfaceDeclaration)

Variable declaration.

Parameters:

children - an ExtList of children. May include: a TypeReference (as reference to the type of the declared variable) several Modifier (taken as modifiers of the declaration), Comments

parentIsInterfaceDeclaration - a boolean set true iff the parent is an InterfaceDeclaration

Method Detail

getFirstElement

public SourceElement getFirstElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs first in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getFirstElement in interface SourceElement

Overrides:

getFirstElement in class JavaSourceElement

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

JavaSourceElement.toSource(), JavaSourceElement.getStartPosition()

getFirstElementIncludingBlocks

public SourceElement getFirstElementIncludingBlocks()

Description copied from interface: SourceElement

Finds the source element that occurs first in the source.

Specified by:

getFirstElementIncludingBlocks in interface SourceElement

Overrides:

getFirstElementIncludingBlocks in class JavaSourceElement

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

SourceElement.getStartPosition()

getLastElement

public SourceElement getLastElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs last in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getLastElement in interface SourceElement

Overrides:

getLastElement in class JavaSourceElement

Returns:

the last source element in the syntactical representation of this element, may be equals to this element.

See Also:

JavaSourceElement.toSource(), JavaSourceElement.getEndPosition()

getTypeReferenceCount

public int getTypeReferenceCount()

Get the number of type references in this container.

Specified by:

getTypeReferenceCount in interface TypeReferenceContainer

Returns:

the number of type references.

getTypeReferenceAt

public TypeReference getTypeReferenceAt(int index)

Specified by:

getTypeReferenceAt in interface TypeReferenceContainer

getTypeReference

public TypeReference getTypeReference()

Get type reference.

Returns:

the type reference.

getVariables

public abstract ImmutableArray<? extends VariableSpecification> getVariables()

Get variables.

Returns:

the variable specification array wrapper

isFinal

public boolean isFinal()

Test whether the declaration is final.

Overrides:

isFinal in class JavaDeclaration

parentIsInterfaceDeclaration

public boolean parentIsInterfaceDeclaration()

this field stores if parent is an InterfaceDeclaration because we will be unable to walk the tree upwards to check this

visit

public void visit(Visitor v)

calls the corresponding method of a visitor in order to perform some action/transformation on this element

Specified by:

visit in interface SourceElement

Parameters:

v - the Visitor

prettyPrint

public void prettyPrint(PrettyPrinter p)
                 throws java.io.IOException

Description copied from class: JavaSourceElement

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Overrides:

prettyPrint in class JavaProgramElement

Parameters:

p - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.