recoder.java.declaration
Class ParameterDeclaration

java.lang.Object
  recoder.java.JavaSourceElement
      recoder.java.JavaProgramElement
          recoder.java.JavaNonTerminalProgramElement
              recoder.java.declaration.JavaDeclaration
                  recoder.java.declaration.VariableDeclaration
                      recoder.java.declaration.ParameterDeclaration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Declaration, NonTerminalProgramElement, ProgramElement, TypeReferenceContainer, SourceElement, ModelElement

public class ParameterDeclaration
extends VariableDeclaration

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface recoder.java.ProgramElement

ProgramElement.TreeStructure

Nested classes/interfaces inherited from interface recoder.java.SourceElement

SourceElement.Position

Field Summary

Fields inherited from class recoder.java.JavaSourceElement

factory

Fields inherited from interface recoder.java.ProgramElement

STRUCTURAL_EQUALITY, STRUCTURAL_HASH_CODE

Constructor Summary

	ParameterDeclaration() Parameter declaration.
	ParameterDeclaration(ASTList<DeclarationSpecifier> mods, TypeReference typeRef, Identifier name) Parameter declaration.
protected	ParameterDeclaration(ParameterDeclaration proto) Parameter declaration.
	ParameterDeclaration(TypeReference typeRef, Identifier name) Parameter declaration.

Method Summary

void	accept(SourceVisitor v) Receive a visitor, for instance a pretty printer.
ParameterDeclaration	deepClone() Deep clone.
NonTerminalProgramElement	getASTParent() Get AST parent.
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	getChildPositionCode(ProgramElement child) Returns the positional code of the given child, or -1 if there is no such child.
ParameterContainer	getParameterContainer() Get parameter container.
java.util.List<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()
void	makeParentRoleValid() Make parent role valid.
boolean	replaceChild(ProgramElement p, ProgramElement q) Replace a single child in the current node.
void	setParameterContainer(ParameterContainer c) Set parameter container.
void	setVarArg(boolean varArg)
void	setVariableSpecification(VariableSpecification vs)

Methods inherited from class recoder.java.declaration.VariableDeclaration

getFirstElement, getLastElement, getTypeReference, getTypeReferenceAt, getTypeReferenceCount, isFinal, setTypeReference

Methods inherited from class recoder.java.declaration.JavaDeclaration

getAnnotations, getDeclarationSpecifiers, getModifiers, getVisibilityModifier, isAbstract, isNative, isStrictFp, isSynchronized, isVolatile, setDeclarationSpecifiers

Methods inherited from class recoder.java.JavaNonTerminalProgramElement

getIndexOfChild, getRoleOfChild, makeAllParentRolesValid, validateAll

Methods inherited from class recoder.java.JavaProgramElement

getComments, getID, setComments, validate

Methods inherited from class recoder.java.JavaSourceElement

getEndPosition, getFactory, getRelativePosition, getStartPosition, setEndPosition, setRelativePosition, setStartPosition, toSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface recoder.java.NonTerminalProgramElement

getIndexOfChild, getRoleOfChild, makeAllParentRolesValid, validateAll

Methods inherited from interface recoder.java.ProgramElement

getComments, getID, setComments

Methods inherited from interface recoder.java.SourceElement

getEndPosition, getFactory, getRelativePosition, getStartPosition, setEndPosition, setRelativePosition, setStartPosition, toSource

Methods inherited from interface recoder.ModelElement

validate

Constructor Detail

ParameterDeclaration

public ParameterDeclaration()

Parameter declaration.

ParameterDeclaration

public ParameterDeclaration(TypeReference typeRef,
                            Identifier name)

Parameter declaration.

Parameters:

typeRef - a type reference.

name - an identifier.

ParameterDeclaration

public ParameterDeclaration(ASTList<DeclarationSpecifier> mods,
                            TypeReference typeRef,
                            Identifier name)

Parameter declaration.

Parameters:

mods - a modifier mutable list.

typeRef - a type reference.

name - an identifier.

ParameterDeclaration

protected ParameterDeclaration(ParameterDeclaration proto)

Parameter declaration.

Parameters:

proto - a parameter declaration.

Method Detail

deepClone

public ParameterDeclaration deepClone()

Deep clone.

Returns:

the object.

makeParentRoleValid

public void makeParentRoleValid()

Make parent role valid.

Specified by:

makeParentRoleValid in interface NonTerminalProgramElement

Overrides:

makeParentRoleValid in class VariableDeclaration

getVariableSpecification

public VariableSpecification getVariableSpecification()

setVariableSpecification

public void setVariableSpecification(VariableSpecification vs)

getVariables

public java.util.List<VariableSpecification> getVariables()

Description copied from class: VariableDeclaration

Get variables. WARNING: as of 0.80 final, this is not a mutable list any more due to implementation of ParameterDeclaration - changes on this list don't have effects there!!

Specified by:

getVariables in class VariableDeclaration

Returns:

the variable specification mutable list.

getASTParent

public NonTerminalProgramElement getASTParent()

Get AST parent.

Returns:

the non terminal program element.

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

getChildPositionCode

public int getChildPositionCode(ProgramElement child)

Description copied from interface: NonTerminalProgramElement

Returns the positional code of the given child, or -1 if there is no such child. The result contains an encoding of the relative position of the child as well as the role it has been playing in this parent element. This information is required internally for proper undo of transformations and is to be delivered to the detached method of the ChangeHistory.

Parameters:

child - the exact child to look for.

Returns:

the positional code of the given child, or -1.

See Also:

ChangeHistory.detached(recoder.java.ProgramElement, recoder.java.NonTerminalProgramElement, int)

replaceChild

public boolean replaceChild(ProgramElement p,
                            ProgramElement q)

Replace a single child in the current node. The child to replace is matched by identity and hence must be known exactly. The replacement element can be null - in that case, the child is effectively removed. The parent role of the new child is validated, while the parent link of the replaced child is left untouched.

Parameters:

p - the old child.

p - the new child.

Returns:

true if a replacement has occured, false otherwise.

Throws:

java.lang.ClassCastException - if the new child cannot take over the role of the old one.

getParameterContainer

public ParameterContainer getParameterContainer()

Get parameter container.

Returns:

the parameter container.

setParameterContainer

public void setParameterContainer(ParameterContainer c)

Set parameter container.

Parameters:

c - a parameter container.

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

accept

public void accept(SourceVisitor v)

Description copied from interface: SourceElement

Receive a visitor, for instance a pretty printer.

Parameters:

v - a source visitor.

isVarArg

public boolean isVarArg()

setVarArg

public void setVarArg(boolean varArg)