recoder.java.declaration
Class AnnotationElementValuePair

java.lang.Object
  recoder.java.JavaSourceElement
      recoder.java.JavaProgramElement
          recoder.java.JavaNonTerminalProgramElement
              recoder.java.declaration.AnnotationElementValuePair

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ElementValuePair, ExpressionContainer, NonTerminalProgramElement, ProgramElement, SourceElement, ModelElement

public class AnnotationElementValuePair
extends JavaNonTerminalProgramElement
implements ExpressionContainer, ElementValuePair

Author:

gutzmann

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

	AnnotationElementValuePair()
protected	AnnotationElementValuePair(AnnotationElementValuePair proto)
	AnnotationElementValuePair(AnnotationPropertyReference elem, Expression elementValue)

Method Summary

void	accept(SourceVisitor v) Receive a visitor, for instance a pretty printer.
AnnotationElementValuePair	deepClone() Creates a deep clone of the current source element.
NonTerminalProgramElement	getASTParent() Yields the syntactical parent node.
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.
AnnotationPropertyReference	getElement()
java.lang.String	getElementName()
Expression	getElementValue()
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.
SourceElement	getLastElement() Finds the source element that occurs last in the source.
AnnotationUseSpecification	getParent()
java.lang.Object	getValue() Returns the value.
void	makeParentRoleValid() Defaults to do nothing.
boolean	replaceChild(ProgramElement p, ProgramElement q) Replace a single non-null child in the current node.
void	setElement(AnnotationPropertyReference ref)
void	setElementValue(Expression elementValue)
void	setParent(AnnotationUseSpecification parent)

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

AnnotationElementValuePair

public AnnotationElementValuePair()

AnnotationElementValuePair

public AnnotationElementValuePair(AnnotationPropertyReference elem,
                                  Expression elementValue)

AnnotationElementValuePair

protected AnnotationElementValuePair(AnnotationElementValuePair proto)

Parameters:

proto -

Method Detail

makeParentRoleValid

public void makeParentRoleValid()

Description copied from class: JavaNonTerminalProgramElement

Defaults to do nothing.

Specified by:

makeParentRoleValid in interface NonTerminalProgramElement

Overrides:

makeParentRoleValid in class JavaNonTerminalProgramElement

getChildCount

public int getChildCount()

Description copied from interface: NonTerminalProgramElement

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)

Description copied from interface: NonTerminalProgramElement

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

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

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)

replaceChild

public boolean replaceChild(ProgramElement p,
                            ProgramElement q)

Description copied from interface: NonTerminalProgramElement

Replace a single non-null 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.

Returns:

true if a replacement has occured, false otherwise.

getASTParent

public NonTerminalProgramElement getASTParent()

Description copied from interface: ProgramElement

Yields the syntactical parent node.

Specified by:

getASTParent in interface ProgramElement

Returns:

the parent node in the syntax tree.

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.

deepClone

public AnnotationElementValuePair deepClone()

Description copied from interface: SourceElement

Creates a deep clone of the current source element. For NonTerminalProgramElements, the parent roles are valid, except that the root element is not included anywhere and hence has no set parents, of course. This method also clones Comment s, but does not clone derived information such as scopes.

Specified by:

deepClone in interface SourceElement

getElementValue

public Expression getElementValue()

setElementValue

public void setElementValue(Expression elementValue)

getElement

public AnnotationPropertyReference getElement()

setElement

public void setElement(AnnotationPropertyReference ref)

getExpressionCount

public int getExpressionCount()

Description copied from interface: ExpressionContainer

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

setParent

public void setParent(AnnotationUseSpecification parent)

getParent

public AnnotationUseSpecification getParent()

getValue

public java.lang.Object getValue()

Description copied from interface: ElementValuePair

Returns the value. Can be either of

• any boxed primitive type
• java.lang.String
• any subtype of java.lang.Class
• a one-dimensional array of any of the above.

Specified by:

getValue in interface ElementValuePair

Returns:

getElementName

public java.lang.String getElementName()

Specified by:

getElementName in interface ElementValuePair