de.uka.ilkd.key.logic

Class ProgramElementName

java.lang.Object

de.uka.ilkd.key.logic.Name

de.uka.ilkd.key.logic.ProgramElementName

All Implemented Interfaces:

Label, ModelElement, ProgramElement, MethodName, ReferenceSuffix, SourceElement, TerminalProgramElement, SVSubstitute, java.lang.Comparable<Name>

Direct Known Subclasses:

VariableNamer.IndProgramElementName

public class ProgramElementName
extends Name
implements TerminalProgramElement, Label, ReferenceSuffix, MethodName

Field Summary

Fields

Modifier and Type	Field and Description
private Comment[]	comments
private NameCreationInfo	creationInfo
private java.lang.String	qualifierString
private java.lang.String	shortName

Constructor Summary

Constructors

Constructor and Description
ProgramElementName(java.lang.String name) create a new name
ProgramElementName(java.lang.String name, Comment[] c) create a new name
ProgramElementName(java.lang.String name, NameCreationInfo creationInfo)
ProgramElementName(java.lang.String name, NameCreationInfo creationInfo, Comment[] c)
ProgramElementName(java.lang.String n, java.lang.String q)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
boolean	equalsModRenaming(SourceElement se, NameAbstractionTable nat) equals modulo renaming is described in the corresponding comment in class SourceElement.
Comment[]	getComments() Get comments.
NameCreationInfo	getCreationInfo()
Position	getEndPosition() Returns the end position of the primary token of this element.
SourceElement	getFirstElement() to be compatible to a ProgramElement
SourceElement	getFirstElementIncludingBlocks() Finds the source element that occurs first in the source.
SourceElement	getLastElement() to be compatible to a ProgramElement
PositionInfo	getPositionInfo() complete position information
java.lang.String	getProgramName()
java.lang.String	getQualifier()
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.
int	hashCode()
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 print.
void	visit(Visitor v) calls the corresponding method of a visitor in order to perform some action/transformation on this element

Methods inherited from class de.uka.ilkd.key.logic.Name

compareTo, toString

Methods inherited from class java.lang.Object

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

Field Detail

qualifierString

private final java.lang.String qualifierString

shortName

private final java.lang.String shortName

creationInfo

private final NameCreationInfo creationInfo

comments

private final Comment[] comments

Constructor Detail

ProgramElementName

public ProgramElementName(java.lang.String name)

create a new name

Parameters:

name - the String with the name of the program element

ProgramElementName

public ProgramElementName(java.lang.String name,
                          Comment[] c)

create a new name

Parameters:

name - the String with the name of the program element

ProgramElementName

public ProgramElementName(java.lang.String name,
                          NameCreationInfo creationInfo)

ProgramElementName

public ProgramElementName(java.lang.String name,
                          NameCreationInfo creationInfo,
                          Comment[] c)

ProgramElementName

public ProgramElementName(java.lang.String n,
                          java.lang.String q)

Method Detail

getComments

public Comment[] getComments()

Description copied from interface: ProgramElement

Get comments.

Specified by:

getComments in interface Label

Specified by:

getComments in interface ProgramElement

Returns:

the comments.

getFirstElement

public SourceElement getFirstElement()

to be compatible to a ProgramElement

Specified by:

getFirstElement in interface Label

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:

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

to be compatible to a ProgramElement

Specified by:

getLastElement in interface Label

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:

SourceElement.getEndPosition()

prettyPrint

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

Description copied from interface: SourceElement

Pretty print.

Specified by:

prettyPrint in interface Label

Specified by:

prettyPrint in interface SourceElement

Parameters:

w - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.

visit

public void visit(Visitor v)

calls the corresponding method of a visitor in order to perform some action/transformation on this element

Specified by:

visit in interface Label

Specified by:

visit in interface SourceElement

Parameters:

v - the Visitor

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 Label

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 Label

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 Label

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

equalsModRenaming

public boolean equalsModRenaming(SourceElement se,
                                 NameAbstractionTable nat)

equals modulo renaming is described in the corresponding comment in class SourceElement. The ProgramElementName has to check if an abstract name has been assigned and if, if both elements are assigned to the same name, otherwise the names have to be equal

Specified by:

equalsModRenaming in interface SourceElement

getQualifier

public java.lang.String getQualifier()

getProgramName

public java.lang.String getProgramName()

getCreationInfo

public NameCreationInfo getCreationInfo()

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Name

hashCode

public int hashCode()

Overrides:

hashCode in class Name