recoder.java.declaration
Class InheritanceSpecification

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Extends, Implements

public abstract class InheritanceSpecification
extends JavaNonTerminalProgramElement
implements TypeReferenceContainer

Inheritance specification.

Author:

AutoDoc

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

	InheritanceSpecification() Inheritance specification.
	InheritanceSpecification(ASTList<TypeReference> supertypes) Inheritance specification.
protected	InheritanceSpecification(InheritanceSpecification proto) Inheritance specification.
	InheritanceSpecification(TypeReference supertype) Inheritance specification.

Method Summary

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	getLastElement() Finds the source element that occurs last in the source.
TypeDeclaration	getParent() Get parent.
ASTList<TypeReference>	getSupertypes() Get supertypes.
TypeReference	getTypeReferenceAt(int index)
int	getTypeReferenceCount() Get the number of type references in this container.
void	makeParentRoleValid() Make parent role valid.
boolean	replaceChild(ProgramElement p, ProgramElement q) Replace a single child in the current node.
void	setParent(TypeDeclaration decl) Set parent.
void	setSupertypes(ASTList<TypeReference> list) Set supertypes.

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, getFirstElement, 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

accept, deepClone, getEndPosition, getFactory, getFirstElement, getRelativePosition, getStartPosition, setEndPosition, setRelativePosition, setStartPosition, toSource

Methods inherited from interface recoder.ModelElement

validate

Constructor Detail

InheritanceSpecification

public InheritanceSpecification()

Inheritance specification.

InheritanceSpecification

public InheritanceSpecification(TypeReference supertype)

Inheritance specification.

Parameters:

supertype - a type reference.

InheritanceSpecification

public InheritanceSpecification(ASTList<TypeReference> supertypes)

Inheritance specification.

Parameters:

supertypes - a type reference mutable list.

InheritanceSpecification

protected InheritanceSpecification(InheritanceSpecification proto)

Inheritance specification.

Parameters:

proto - an inheritance specification.

Method Detail

getASTParent

public NonTerminalProgramElement getASTParent()

Get AST parent.

Specified by:

getASTParent in interface ProgramElement

Returns:

the non terminal program element.

makeParentRoleValid

public void makeParentRoleValid()

Make parent role valid.

Specified by:

makeParentRoleValid in interface NonTerminalProgramElement

Overrides:

makeParentRoleValid in class JavaNonTerminalProgramElement

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

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.

getParent

public TypeDeclaration getParent()

Get parent.

Returns:

the type declaration.

setParent

public void setParent(TypeDeclaration decl)

Set parent.

Parameters:

decl - a type declaration.

getSupertypes

public ASTList<TypeReference> getSupertypes()

Get supertypes.

Returns:

the type reference mutable list.

setSupertypes

public void setSupertypes(ASTList<TypeReference> list)

Set supertypes.

Parameters:

list - a type reference mutable list.

getTypeReferenceCount

public int getTypeReferenceCount()

Get the number of type references in this container.

Specified by:

getTypeReferenceCount in interface TypeReferenceContainer

Returns:

the number of type references.

getTypeReferenceAt

public TypeReference getTypeReferenceAt(int index)

Specified by:

getTypeReferenceAt in interface TypeReferenceContainer