de.uka.ilkd.key.java.declaration

Class ParameterDeclaration

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

All Implemented Interfaces:

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

public class ParameterDeclaration
extends VariableDeclaration

Formal parameters require a VariableSpecificationList of size() <= 1 (size() == 0 for abstract methods) without initializer (for Java).

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	varArgParameter flag to store whether this parameter is a the last arg in a method declaration with variable number of arguments. false if not otherwise set in the appropriate constructor.
protected ImmutableArray<VariableSpecification>	varSpec Var spec.

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
ParameterDeclaration() Parameter declaration.
ParameterDeclaration(ExtList children, boolean parentIsInterfaceDeclaration, boolean parameterIsVarArg) Parameter declaration.
ParameterDeclaration(Modifier[] mods, TypeReference typeRef, VariableSpecification var, boolean parentIsInterfaceDeclaration) Parameter declaration.
ParameterDeclaration(Modifier[] mods, TypeReference typeRef, VariableSpecification var, boolean parentIsInterfaceDeclaration, boolean parameterIsVarArg) Parameter declaration.

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() Get variables.
VariableSpecification	getVariableSpecification()
boolean	isPrivate() Parameters are never private.
boolean	isProtected() Parameters are never protected.
boolean	isPublic() Parameters are never public.
boolean	isStatic() Parameters are never static.
boolean	isTransient() Parameters are never transient.
boolean	isVarArg() returns true iff this parameter is the last in a method with a variable number of arguments.
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, prettyPrint

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, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

varSpec

protected final ImmutableArray<VariableSpecification> varSpec

Var spec.

varArgParameter

private final boolean varArgParameter

flag to store whether this parameter is a the last arg in a method declaration with variable number of arguments. false if not otherwise set in the appropriate constructor.

Constructor Detail

ParameterDeclaration

public ParameterDeclaration()

Parameter declaration.

ParameterDeclaration

public ParameterDeclaration(Modifier[] mods,
                            TypeReference typeRef,
                            VariableSpecification var,
                            boolean parentIsInterfaceDeclaration,
                            boolean parameterIsVarArg)

Parameter declaration.

Parameters:

mods - a modifier array.

typeRef - a type reference.

var - the VariableSpecification belonging to this parameter declaration.

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

parameterIsVarArg - true iff this the last parameter of a method with variable number of arguments

ParameterDeclaration

public ParameterDeclaration(Modifier[] mods,
                            TypeReference typeRef,
                            VariableSpecification var,
                            boolean parentIsInterfaceDeclaration)

Parameter declaration.

Parameters:

mods - a modifier array.

typeRef - a type reference.

var - the VariableSpecification belonging to this parameter declaration.

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

ParameterDeclaration

public ParameterDeclaration(ExtList children,
                            boolean parentIsInterfaceDeclaration,
                            boolean parameterIsVarArg)

Parameter declaration.

Parameters:

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

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

parameterIsVarArg - true iff this the last parameter of a method with variable number of arguments

Method Detail

getVariableSpecification

public VariableSpecification getVariableSpecification()

getVariables

public ImmutableArray<VariableSpecification> getVariables()

Description copied from class: VariableDeclaration

Get variables.

Specified by:

getVariables in class VariableDeclaration

Returns:

the variable specification array wrapper

getChildCount

public int getChildCount()

Returns the number of children of this node.

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

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

Parameters are never private.

Overrides:

isPrivate in class JavaDeclaration

isProtected

public boolean isProtected()

Parameters are never protected.

Overrides:

isProtected in class JavaDeclaration

isPublic

public boolean isPublic()

Parameters are never public.

Overrides:

isPublic in class JavaDeclaration

isStatic

public boolean isStatic()

Parameters are never static.

Overrides:

isStatic in class JavaDeclaration

isTransient

public boolean isTransient()

Parameters 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

isVarArg

public boolean isVarArg()

returns true iff this parameter is the last in a method with a variable number of arguments.

Returns:

true if the parameter is the last in a method with a variable number of arguments