recoder.java.reference
Class PackageReference

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

All Implemented Interfaces:

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

public class PackageReference
extends JavaNonTerminalProgramElement
implements TypeReferenceInfix, PackageReferenceContainer

Package reference.

Author:

AutoDoc

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface recoder.NamedModelElement

NamedModelElement.LexicalOrder

Field Summary

Fields inherited from class recoder.java.JavaSourceElement

factory

Fields inherited from interface recoder.NamedModelElement

LEXICAL_ORDER

Constructor Summary

	PackageReference() Package reference.
	PackageReference(Identifier id) Package reference.
protected	PackageReference(PackageReference proto) Package reference.
	PackageReference(PackageReference path, Identifier id) Package reference.

Method Summary

void	accept(SourceVisitor v) Receive a visitor, for instance a pretty printer.
PackageReference	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.
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
Identifier	getIdentifier() Get identifier.
SourceElement	getLastElement() Finds the source element that occurs last in the source.
java.lang.String	getName() Get name.
PackageReference	getPackageReference() Get the package reference.
ReferencePrefix	getReferencePrefix() Get reference prefix.
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	setIdentifier(Identifier id) Set identifier.
void	setParent(PackageReferenceContainer parent) Set package specification.
void	setReferencePrefix(ReferencePrefix prefix) Set reference prefix.
void	setReferenceSuffix(ReferenceSuffix x) 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, getRelativePosition, getStartPosition, setEndPosition, setRelativePosition, setStartPosition, toSource

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageReference

public PackageReference()

Package reference.

PackageReference

public PackageReference(Identifier id)

Package reference.

Parameters:

id - an identifier.

PackageReference

public PackageReference(PackageReference path,
                        Identifier id)

Package reference.

Parameters:

path - a package reference.

id - an identifier.

PackageReference

protected PackageReference(PackageReference proto)

Package reference.

Parameters:

proto - a package reference.

Method Detail

deepClone

public PackageReference deepClone()

Deep clone.

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

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

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)

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.

setParent

public void setParent(PackageReferenceContainer parent)

Set package specification.

Parameters:

parent - a package specification.

getReferencePrefix

public ReferencePrefix getReferencePrefix()

Get reference prefix.

Specified by:

getReferencePrefix in interface ReferenceSuffix

Returns:

the reference prefix.

getPackageReference

public PackageReference getPackageReference()

Get the package reference.

Specified by:

getPackageReference in interface PackageReferenceContainer

Returns:

the package reference.

setReferencePrefix

public void setReferencePrefix(ReferencePrefix prefix)

Set reference prefix.

Specified by:

setReferencePrefix in interface TypeReferenceInfix

Parameters:

prefix - a reference prefix.

getReferenceSuffix

public ReferenceSuffix getReferenceSuffix()

Get reference suffix.

Specified by:

getReferenceSuffix in interface ReferencePrefix

Returns:

the reference suffix.

setReferenceSuffix

public void setReferenceSuffix(ReferenceSuffix x)

Set reference suffix. Must be a PackageReferenceContainer.

Specified by:

setReferenceSuffix in interface ReferencePrefix

Parameters:

x - a reference suffix.

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.

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.