de.uka.ilkd.key.java.declaration

Class LocalVariableDeclaration

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

de.uka.ilkd.key.java.declaration.LocalVariableDeclaration

All Implemented Interfaces:

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

public class LocalVariableDeclaration
extends VariableDeclaration
implements LoopInitializer

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ImmutableArray<VariableSpecification>	varSpecs Var specs.

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

parentIsInterfaceDeclaration, typeReference

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

modArray

Constructor Summary

Constructors

Constructor and Description
LocalVariableDeclaration() Local variable declaration.
LocalVariableDeclaration(ExtList children) Local variable declaration.
LocalVariableDeclaration(ImmutableArray<Modifier> mods, TypeReference typeRef, VariableSpecification var) Local variable declaration.
LocalVariableDeclaration(ImmutableArray<Modifier> mods, TypeReference typeRef, VariableSpecification[] vars) Local variable declaration.
LocalVariableDeclaration(Modifier[] mods, TypeReference typeRef, VariableSpecification[] vars) Local variable declaration.
LocalVariableDeclaration(TypeReference typeRef, VariableSpecification var) Local variable declaration which declared exactly one variable.

Method Summary

Modifier and Type	Method and Description
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.
ImmutableArray<VariableSpecification>	getVariables() This method is identical to getVariableSpecifications().
ImmutableArray<VariableSpecification>	getVariableSpecifications() This method is identical to getVariables().
boolean	isPrivate() Local variables are never private.
boolean	isProtected() Local variables are never protected..
boolean	isPublic() Local variables are never "public".
boolean	isStatic() Local variables are never static.
boolean	isTransient() Local variables are never transient.
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.VariableDeclaration

getFirstElement, getFirstElementIncludingBlocks, getLastElement, getTypeReference, getTypeReferenceAt, getTypeReferenceCount, isFinal, parentIsInterfaceDeclaration

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

getModifiers, getStateCount, getVisibilityModifier, isAbstract, isGhost, isModel, isNative, isStrictFp, isSynchronized, 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.ProgramElement

getComments, match

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

equalsModRenaming, getEndPosition, getFirstElement, getFirstElementIncludingBlocks, getLastElement, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

varSpecs

protected final ImmutableArray<VariableSpecification> varSpecs

Var specs.

Constructor Detail

LocalVariableDeclaration

public LocalVariableDeclaration()

Local variable declaration.

LocalVariableDeclaration

public LocalVariableDeclaration(Modifier[] mods,
                                TypeReference typeRef,
                                VariableSpecification[] vars)

Local variable declaration.

Parameters:

mods - a modifier array.

typeRef - a type reference.

vars - a variable specification array.

LocalVariableDeclaration

public LocalVariableDeclaration(TypeReference typeRef,
                                VariableSpecification var)

Local variable declaration which declared exactly one variable.

Parameters:

typeRef - a type reference.

var - the variable specification

LocalVariableDeclaration

public LocalVariableDeclaration(ImmutableArray<Modifier> mods,
                                TypeReference typeRef,
                                VariableSpecification var)

Local variable declaration.

Parameters:

mods - a modifier array.

typeRef - a type reference.

var - a variable specification .

LocalVariableDeclaration

public LocalVariableDeclaration(ImmutableArray<Modifier> mods,
                                TypeReference typeRef,
                                VariableSpecification[] vars)

Local variable declaration.

Parameters:

mods - a modifier array.

typeRef - a type reference.

vars - a variable specification array.

LocalVariableDeclaration

public LocalVariableDeclaration(ExtList children)

Local variable declaration.

Parameters:

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

Method Detail

getVariableSpecifications

public ImmutableArray<VariableSpecification> getVariableSpecifications()

This method is identical to getVariables().

getVariables

public ImmutableArray<VariableSpecification> getVariables()

This method is identical to getVariableSpecifications().

Specified by:

getVariables in class VariableDeclaration

Returns:

the variable specification array wrapper

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

isPrivate

public boolean isPrivate()

Local variables are never private.

Overrides:

isPrivate in class JavaDeclaration

isProtected

public boolean isProtected()

Local variables are never protected..

Overrides:

isProtected in class JavaDeclaration

isPublic

public boolean isPublic()

Local variables are never "public".

Overrides:

isPublic in class JavaDeclaration

isStatic

public boolean isStatic()

Local variables are never static.

Overrides:

isStatic in class JavaDeclaration

isTransient

public boolean isTransient()

Local variables are never transient.

Overrides:

isTransient in class JavaDeclaration

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

Overrides:

visit in class VariableDeclaration

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 VariableDeclaration

Parameters:

p - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.