de.uka.ilkd.key.java.declaration

Class VariableSpecification

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.VariableSpecification

All Implemented Interfaces:

ProgramModelElement, Variable, ExpressionContainer, ModelElement, NamedModelElement, NamedProgramElement, NonTerminalProgramElement, ProgramElement, SourceElement, SVSubstitute

Direct Known Subclasses:

FieldSpecification

public class VariableSpecification
extends JavaNonTerminalProgramElement
implements NamedProgramElement, ExpressionContainer, Variable

Variable specification that defines a variable name. This is a part of a VariableDeclaration and does not contain a type reference or own modifiers. Note that calls to modifiers are delegated to the enclosing variable declaration and are therefore discouraged. This was necessary to subtype Declaration as analyses are interested in the exact location of a variable name.

Author:

AL

Field Summary

Fields

Modifier and Type	Field and Description
protected int	dimensions Dimensions.
protected Expression	initializer Initializer.
protected Type	type the type
protected IProgramVariable	var

Constructor Summary

Constructors

Constructor and Description
VariableSpecification()
VariableSpecification(ExtList children, IProgramVariable var, int dim, Type type) Constructor for the transformation of RECODER ASTs to KeY.
VariableSpecification(IProgramVariable var)
VariableSpecification(IProgramVariable var, Expression init, Type type)
VariableSpecification(IProgramVariable var, int dim, Expression init, Type type)
VariableSpecification(IProgramVariable var, int dim, Expression init, Type type, PositionInfo pi)
VariableSpecification(IProgramVariable var, Type type)

Method Summary

Modifier and Type	Method and Description
protected int	computeHashCode()
boolean	equals(java.lang.Object o)
boolean	equalsModRenaming(SourceElement se, NameAbstractionTable nat) equals modulo renaming is described in the corresponding comment in class SourceElement.
ProgramElement	getChildAt(int index) Returns the child at the specified index in this node's "virtual" child array
int	getChildCount() Returns the number of children of this node.
int	getDimensions() Get dimensions.
Expression	getExpressionAt(int index)
int	getExpressionCount() Get the number of expressions in this container.
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
java.lang.String	getFullName() Returns the maximal expanded name including all applicable qualifiers.
Expression	getInitializer() Get initializer.
SourceElement	getLastElement() Finds the source element that occurs last in the source.
java.lang.String	getName() Get name.
ProgramElementName	getProgramElementName() Get name.
IProgramVariable	getProgramVariable() Get program variable
Type	getType() Returns the type of this variable.
boolean	hasInitializer()
boolean	isFinal() Checks if this variable is final.
MatchConditions	match(SourceData source, MatchConditions matchCond) matches the source "text" (@link SourceData#getSource()) against the pattern represented by this object.
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.JavaNonTerminalProgramElement

compatibleBlockSize, getArrayPos, 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, getFirstElementIncludingBlocks, 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.ProgramElement

getComments

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

getEndPosition, getFirstElementIncludingBlocks, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

initializer

protected final Expression initializer

Initializer.

dimensions

protected final int dimensions

Dimensions.

type

protected final Type type

the type

var

protected final IProgramVariable var

Constructor Detail

VariableSpecification

public VariableSpecification()

VariableSpecification

public VariableSpecification(IProgramVariable var)

VariableSpecification

public VariableSpecification(IProgramVariable var,
                             Type type)

VariableSpecification

public VariableSpecification(IProgramVariable var,
                             Expression init,
                             Type type)

VariableSpecification

public VariableSpecification(IProgramVariable var,
                             int dim,
                             Expression init,
                             Type type)

VariableSpecification

public VariableSpecification(IProgramVariable var,
                             int dim,
                             Expression init,
                             Type type,
                             PositionInfo pi)

VariableSpecification

public VariableSpecification(ExtList children,
                             IProgramVariable var,
                             int dim,
                             Type type)

Constructor for the transformation of RECODER ASTs to KeY.

Parameters:

children - the children of this AST element as KeY classes. May contain: an Expression (as initializer of the variable) a Comment

dim - the dimension of this type

Method Detail

getChildCount

public int getChildCount()

Returns the number of children of this node.

Specified by:

getChildCount in interface NonTerminalProgramElement

Returns:

an int giving the number of children of this node

getChildAt

public ProgramElement getChildAt(int index)

Returns the child at the specified index in this node's "virtual" child array

Specified by:

getChildAt in interface NonTerminalProgramElement

Parameters:

index - an index into this node's "virtual" child array

Returns:

the program element at the given position

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds

computeHashCode

protected int computeHashCode()

Overrides:

computeHashCode in class JavaNonTerminalProgramElement

getExpressionCount

public int getExpressionCount()

Get the number of expressions in this container.

Specified by:

getExpressionCount in interface ExpressionContainer

Returns:

the number of expressions.

getExpressionAt

public Expression getExpressionAt(int index)

Specified by:

getExpressionAt in interface ExpressionContainer

getName

public final java.lang.String getName()

Get name.

Specified by:

getName in interface NamedModelElement

Returns:

the string.

getProgramElementName

public ProgramElementName getProgramElementName()

Get name.

Specified by:

getProgramElementName in interface NamedProgramElement

Returns:

the name.

getProgramVariable

public IProgramVariable getProgramVariable()

Get program variable

Returns:

the program variable.

getDimensions

public int getDimensions()

Get dimensions.

Returns:

the int value.

getInitializer

public Expression getInitializer()

Get initializer.

Returns:

the expression.

hasInitializer

public boolean hasInitializer()

isFinal

public boolean isFinal()

Description copied from interface: Variable

Checks if this variable is final.

Specified by:

isFinal in interface Variable

Returns:

true if this variable is final, false otherwise.

getType

public Type getType()

Description copied from interface: Variable

Returns the type of this variable.

Specified by:

getType in interface Variable

Returns:

the type of this variable.

getFullName

public java.lang.String getFullName()

Description copied from interface: ProgramModelElement

Returns the maximal expanded name including all applicable qualifiers.

Specified by:

getFullName in interface ProgramModelElement

Returns:

the full name of this program model element.

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()

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()

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.

equalsModRenaming

public boolean equalsModRenaming(SourceElement se,
                                 NameAbstractionTable nat)

equals modulo renaming is described in the corresponding comment in class SourceElement. The variables declared in the local variable declaration have to be added to the NameAbstractionTable.

Specified by:

equalsModRenaming in interface SourceElement

Overrides:

equalsModRenaming in class JavaNonTerminalProgramElement

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class JavaNonTerminalProgramElement

match

public MatchConditions match(SourceData source,
                             MatchConditions matchCond)

Description copied from interface: ProgramElement

matches the source "text" (@link SourceData#getSource()) against the pattern represented by this object. In case of a successful match the resulting MatchConditions with the found instantiations of the schemavariables. If the match failed, null is returned instead.

Specified by:

match in interface ProgramElement

Overrides:

match in class JavaNonTerminalProgramElement

Parameters:

source - the SourceData with the program element to match

matchCond - the MatchConditions found up to this point

Returns:

the resulting match conditions or null if the match failed