de.uka.ilkd.key.java

Class JavaProgramElement

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

de.uka.ilkd.key.java.JavaProgramElement

All Implemented Interfaces:

ModelElement, ProgramElement, SourceElement, SVSubstitute

Direct Known Subclasses:

EmptyStatement, JavaNonTerminalProgramElement, Literal, Modifier

public abstract class JavaProgramElement
extends JavaSourceElement
implements ProgramElement

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	JavaProgramElement.NameAbstractionTableDisabled this class is used by method call.

Field Summary

Fields

Modifier and Type	Field and Description
private Comment[]	comments
private int	hashCode
private static Comment[]	NO_COMMENTS

Constructor Summary

Constructors

Constructor and Description
JavaProgramElement()
JavaProgramElement(ExtList list) Java program element.
JavaProgramElement(ExtList children, PositionInfo pos)
JavaProgramElement(PositionInfo pos) creates a java program element with the given position information

Method Summary

Modifier and Type	Method and Description
protected int	computeHashCode()
boolean	equals(java.lang.Object o)
boolean	equalsModRenaming(SourceElement se, NameAbstractionTable nat) commented in interface SourceElement.
private Comment[]	extractComments(ExtList list) collects comments contained in the given list
Comment[]	getComments() Get comments.
int	hashCode() if you need to customize the hashcode computation for a subclass please override method computeHashCode()
MatchConditions	match(SourceData source, MatchConditions matchCond) matches the source "text" (@link SourceData#getSource()) against the pattern represented by this object.
void	prettyPrint(PrettyPrinter w) Pretty printing the source element.
protected void	prettyPrintMain(PrettyPrinter w) Prints main content of current node and all syntactical children.
java.lang.String	reuseSignature(Services services, ExecutionContext ec) this is the default implementation of the signature, which is used to determine program similarity.

Methods inherited from class de.uka.ilkd.key.java.JavaSourceElement

getEndPosition, getFirstElement, getFirstElementIncludingBlocks, getLastElement, getParentClass, getPositionInfo, getRelativePosition, getStartPosition, setParentClass, toSource, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getEndPosition, getFirstElement, getFirstElementIncludingBlocks, getLastElement, getPositionInfo, getRelativePosition, getStartPosition, visit

Field Detail

NO_COMMENTS

private static final Comment[] NO_COMMENTS

comments

private final Comment[] comments

hashCode

private int hashCode

Constructor Detail

JavaProgramElement

public JavaProgramElement()

JavaProgramElement

public JavaProgramElement(ExtList list)

Java program element.

Parameters:

list - ExtList with comments

JavaProgramElement

public JavaProgramElement(PositionInfo pos)

creates a java program element with the given position information

Parameters:

pos - the PositionInfo where the Java program element occurs in the source

JavaProgramElement

public JavaProgramElement(ExtList children,
                          PositionInfo pos)

Method Detail

extractComments

private Comment[] extractComments(ExtList list)

collects comments contained in the given list

Parameters:

list - the ExtList with children and comments of this node

getComments

public Comment[] getComments()

Get comments.

Specified by:

getComments in interface ProgramElement

Returns:

the comments.

prettyPrint

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

Description copied from class: JavaSourceElement

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Specified by:

prettyPrint in class JavaSourceElement

Parameters:

w - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.

prettyPrintMain

protected void prettyPrintMain(PrettyPrinter w)
                        throws java.io.IOException

Prints main content of current node and all syntactical children. Hook method of prettyPrint; defaults to do nothing.

Throws:

java.io.IOException

equalsModRenaming

public boolean equalsModRenaming(SourceElement se,
                                 NameAbstractionTable nat)

commented in interface SourceElement. The default equals method compares two elements by testing if they have the same type and calling the default equals method.

Specified by:

equalsModRenaming in interface SourceElement

computeHashCode

protected int computeHashCode()

hashCode

public final int hashCode()

if you need to customize the hashcode computation for a subclass please override method computeHashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

reuseSignature

public java.lang.String reuseSignature(Services services,
                                       ExecutionContext ec)

this is the default implementation of the signature, which is used to determine program similarity.

Parameters:

ec - TODO

match

public MatchConditions match(SourceData source,
                             MatchConditions matchCond)

Description copied from interface: ProgramElement

matches the source "text" (@link SourceData#getSource()) against the pattern represented by this object. In case of a successful match the resulting MatchConditions with the found instantiations of the schemavariables. If the match failed, null is returned instead.

Specified by:

match in interface ProgramElement

Parameters:

source - the SourceData with the program element to match

matchCond - the MatchConditions found up to this point

Returns:

the resulting match conditions or null if the match failed