recoder.java.statement
Class LabeledStatement

java.lang.Object
  recoder.java.JavaSourceElement
      recoder.java.JavaProgramElement
          recoder.java.JavaNonTerminalProgramElement
              recoder.java.statement.JavaStatement
                  recoder.java.statement.LabeledStatement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, NamedProgramElement, NonTerminalProgramElement, ProgramElement, SourceElement, Statement, StatementContainer, ModelElement, NamedModelElement

public class LabeledStatement
extends JavaStatement
implements StatementContainer, NamedProgramElement

Labeled statement.

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

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.java.ProgramElement

STRUCTURAL_EQUALITY, STRUCTURAL_HASH_CODE

Fields inherited from interface recoder.NamedModelElement

LEXICAL_ORDER

Fields inherited from interface recoder.java.ProgramElement

STRUCTURAL_EQUALITY, STRUCTURAL_HASH_CODE

Constructor Summary

	LabeledStatement() Labeled statement.
	LabeledStatement(Identifier id) Labeled statement.
	LabeledStatement(Identifier id, Statement statement) Labeled statement.
protected	LabeledStatement(LabeledStatement proto) Labeled statement.

Method Summary

void	accept(SourceVisitor v) Receive a visitor, for instance a pretty printer.
LabeledStatement	deepClone() Deep clone.
Statement	getBody() Get body.
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.
Statement	getStatementAt(int index) Return the statement at the specified index in this node's "virtual" statement array.
int	getStatementCount() Get the number of statements in this container.
void	makeParentRoleValid() Make parent role valid.
boolean	replaceChild(ProgramElement p, ProgramElement q) Replace a single child in the current node.
void	setBody(Statement s) Set body.
void	setIdentifier(Identifier id) Set identifier.

Methods inherited from class recoder.java.statement.JavaStatement

getASTParent, getStatementContainer, setStatementContainer

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

getASTParent, getComments, getID, setComments

Methods inherited from interface recoder.java.SourceElement

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

Methods inherited from interface recoder.java.NonTerminalProgramElement

getIndexOfChild, getRoleOfChild, makeAllParentRolesValid, validateAll

Methods inherited from interface recoder.java.ProgramElement

getASTParent, getComments, getID, setComments

Methods inherited from interface recoder.java.SourceElement

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

Constructor Detail

LabeledStatement

public LabeledStatement()

Labeled statement.

LabeledStatement

public LabeledStatement(Identifier id)

Labeled statement.

Parameters:

id - an identifier.

LabeledStatement

public LabeledStatement(Identifier id,
                        Statement statement)

Labeled statement.

Parameters:

id - an identifier.

statement - a statement.

LabeledStatement

protected LabeledStatement(LabeledStatement proto)

Labeled statement.

Parameters:

proto - a labeled statement.

Method Detail

deepClone

public LabeledStatement deepClone()

Deep clone.

Specified by:

deepClone in interface SourceElement

Specified by:

deepClone in interface Statement

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

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.

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.

getBody

public Statement getBody()

Get body.

Returns:

the statement.

setBody

public void setBody(Statement s)

Set body.

Parameters:

s - a statement.

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)

getStatementCount

public int getStatementCount()

Get the number of statements in this container.

Specified by:

getStatementCount in interface StatementContainer

Returns:

the number of statements.

getStatementAt

public Statement getStatementAt(int index)

Return the statement at the specified index in this node's "virtual" statement array.

Specified by:

getStatementAt in interface StatementContainer

Parameters:

index - an index for a statement.

Returns:

the statement with the given index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds.

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.