de.uka.ilkd.key.java

Class JavaSourceElement

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

All Implemented Interfaces:

SourceElement, SVSubstitute

Direct Known Subclasses:

Comment, JavaProgramElement

public abstract class JavaSourceElement
extends java.lang.Object
implements SourceElement

Top level implementation of a Java SourceElement. taken from COMPOST and changed to achieve an immutable structure

Field Summary

Fields

Modifier and Type	Field and Description
private PositionInfo	posInfo

Constructor Summary

Constructors

Constructor and Description
JavaSourceElement() Java source element.
JavaSourceElement(ExtList children) Java source element.
JavaSourceElement(ExtList children, PositionInfo pos)
JavaSourceElement(PositionInfo pi) Java source element.

Method Summary

Modifier and Type	Method and Description
Position	getEndPosition() Returns the end position of the primary token of this element.
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
SourceElement	getFirstElementIncludingBlocks() Finds the source element that occurs first in the source.
SourceElement	getLastElement() Finds the source element that occurs last in the source.
java.lang.String	getParentClass() get the class the statement originates from
private PositionInfo	getPosInfo(PositionInfo p) internal method use to guarantee the position info object is always not the null reference
PositionInfo	getPositionInfo() complete position information
Position	getRelativePosition() Returns the relative position (number of blank heading lines and columns) of the primary token of this element.
Position	getStartPosition() Returns the start position of the primary token of this element.
abstract void	prettyPrint(PrettyPrinter w) Pretty printing the source element.
protected void	setParentClass(java.lang.String s) this violates immutability, but the method is only called right after the object is created...
java.lang.String	toSource() Creates a syntactical representation of the source element using the prettyPrint(de.uka.ilkd.key.java.PrettyPrinter) method.
java.lang.String	toString() toString
java.lang.String	toString(PrettyPrinter pp, java.io.StringWriter sw)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uka.ilkd.key.java.SourceElement

equalsModRenaming, visit

Field Detail

posInfo

private final PositionInfo posInfo

Constructor Detail

JavaSourceElement

public JavaSourceElement()

Java source element.

JavaSourceElement

public JavaSourceElement(PositionInfo pi)

Java source element.

Parameters:

pi - PositionInfo the PositionInfo of the element

JavaSourceElement

public JavaSourceElement(ExtList children)

Java source element.

Parameters:

children - a list of the children of this element. May contain: PositionInfo

JavaSourceElement

public JavaSourceElement(ExtList children,
                         PositionInfo pos)

Method Detail

getPosInfo

private PositionInfo getPosInfo(PositionInfo p)

internal method use to guarantee the position info object is always not the null reference

Parameters:

p - a PositionInfo

Returns:

if p is null the undefined position (PositionInfo.UNDEFINED) is returned otherwise p

getFirstElement

public SourceElement getFirstElement()

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

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

toSource(), getStartPosition()

getFirstElementIncludingBlocks

public SourceElement getFirstElementIncludingBlocks()

Description copied from interface: SourceElement

Finds the source element that occurs first in the source.

Specified by:

getFirstElementIncludingBlocks in interface SourceElement

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

SourceElement.getStartPosition()

getLastElement

public SourceElement getLastElement()

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

Returns:

the last source element in the syntactical representation of this element, may be equals to this element.

See Also:

toSource(), getEndPosition()

prettyPrint

public abstract void prettyPrint(PrettyPrinter w)
                          throws java.io.IOException

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Parameters:

w - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.

toSource

public java.lang.String toSource()

Creates a syntactical representation of the source element using the prettyPrint(de.uka.ilkd.key.java.PrettyPrinter) method.

getStartPosition

public Position getStartPosition()

Returns the start position of the primary token of this element. To get the start position of the syntactical first token, call the corresponding method of getFirstElement().

Specified by:

getStartPosition in interface SourceElement

Returns:

the start position of the primary token.

getEndPosition

public Position getEndPosition()

Returns the end position of the primary token of this element. To get the end position of the syntactical first token, call the corresponding method of getLastElement().

Specified by:

getEndPosition in interface SourceElement

Returns:

the end position of the primary token.

getRelativePosition

public Position getRelativePosition()

Returns the relative position (number of blank heading lines and columns) of the primary token of this element. To get the relative position of the syntactical first token, call the corresponding method of getFirstElement().

Specified by:

getRelativePosition in interface SourceElement

Returns:

the relative position of the primary token.

getPositionInfo

public PositionInfo getPositionInfo()

Description copied from interface: SourceElement

complete position information

Specified by:

getPositionInfo in interface SourceElement

toString

public java.lang.String toString()

toString

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(PrettyPrinter pp,
                                 java.io.StringWriter sw)

setParentClass

protected void setParentClass(java.lang.String s)

this violates immutability, but the method is only called right after the object is created...

getParentClass

public java.lang.String getParentClass()

get the class the statement originates from