recoder.java.reference
Class VariableReference

java.lang.Object
  recoder.java.JavaSourceElement
      recoder.java.JavaProgramElement
          recoder.java.JavaNonTerminalProgramElement
              recoder.java.reference.VariableReference

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Expression, NamedProgramElement, NonTerminalProgramElement, ProgramElement, Reference, NameReference, ReferencePrefix, SourceElement, ModelElement, NamedModelElement

Direct Known Subclasses:

FieldReference

public class VariableReference
extends JavaNonTerminalProgramElement
implements NameReference, Expression, ReferencePrefix

Variable reference.

Author:

AutoDoc

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface recoder.NamedModelElement

NamedModelElement.LexicalOrder

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

LEXICAL_ORDER

Fields inherited from interface recoder.java.ProgramElement

STRUCTURAL_EQUALITY, STRUCTURAL_HASH_CODE

Constructor Summary

	VariableReference() Variable reference.
	VariableReference(Identifier id) Variable reference.
protected	VariableReference(VariableReference proto) Variable reference.

Method Summary

void	accept(SourceVisitor v) Receive a visitor, for instance a pretty printer.
VariableReference	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.
ExpressionContainer	getExpressionContainer() Get expression container.
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
Identifier	getIdentifier() Get identifier.
java.lang.String	getName() Get name.
ReferenceSuffix	getReferenceSuffix() Get reference suffix.
void	makeParentRoleValid() Make parent role valid.
boolean	replaceChild(ProgramElement p, ProgramElement q) Replace a single child in the current node.
void	setExpressionContainer(ExpressionContainer c) Set expression container.
void	setIdentifier(Identifier id) Set identifier.
void	setReferenceSuffix(ReferenceSuffix path) Set reference suffix.

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, getLastElement, 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, getLastElement, getRelativePosition, getStartPosition, setEndPosition, setRelativePosition, setStartPosition, toSource

Constructor Detail

VariableReference

public VariableReference()

Variable reference.

VariableReference

public VariableReference(Identifier id)

Variable reference.

Parameters:

id - an identifier.

VariableReference

protected VariableReference(VariableReference proto)

Variable reference.

Parameters:

proto - a variable reference.

Method Detail

deepClone

public VariableReference deepClone()

Deep clone.

Specified by:

deepClone in interface Expression

Specified by:

deepClone in interface SourceElement

Returns:

the object.

makeParentRoleValid

public void makeParentRoleValid()

Make parent role valid.

Specified by:

makeParentRoleValid in interface NonTerminalProgramElement

Overrides:

makeParentRoleValid in class JavaNonTerminalProgramElement

getASTParent

public NonTerminalProgramElement getASTParent()

Get AST parent.

Specified by:

getASTParent in interface ProgramElement

Returns:

the non terminal program element.

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

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.

Specified by:

getChildPositionCode in interface NonTerminalProgramElement

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)

getReferenceSuffix

public ReferenceSuffix getReferenceSuffix()

Get reference suffix.

Specified by:

getReferenceSuffix in interface ReferencePrefix

Returns:

the reference suffix.

setReferenceSuffix

public void setReferenceSuffix(ReferenceSuffix path)

Set reference suffix.

Specified by:

setReferenceSuffix in interface ReferencePrefix

Parameters:

path - a reference suffix.

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.

Specified by:

replaceChild in interface NonTerminalProgramElement

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.

getExpressionContainer

public ExpressionContainer getExpressionContainer()

Get expression container.

Specified by:

getExpressionContainer in interface Expression

Returns:

the expression container.

setExpressionContainer

public void setExpressionContainer(ExpressionContainer c)

Set expression container.

Specified by:

setExpressionContainer in interface Expression

Parameters:

c - an expression container.

getName

public final java.lang.String getName()

Get name.

Specified by:

getName in interface NamedModelElement

Returns:

the string.

getIdentifier

public Identifier getIdentifier()

Get identifier.

Specified by:

getIdentifier in interface NamedProgramElement

Returns:

the identifier.

setIdentifier

public void setIdentifier(Identifier id)

Set identifier.

Specified by:

setIdentifier in interface NamedProgramElement

Parameters:

id - an identifier.

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

accept

public void accept(SourceVisitor v)

Description copied from interface: SourceElement

Receive a visitor, for instance a pretty printer.

Specified by:

accept in interface SourceElement

Parameters:

v - a source visitor.