de.uka.ilkd.key.java.reference

Class TypeReferenceImp

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

de.uka.ilkd.key.java.JavaProgramElement

de.uka.ilkd.key.java.JavaNonTerminalProgramElement

de.uka.ilkd.key.java.reference.TypeReferenceImp

All Implemented Interfaces:

ExpressionContainer, ModelElement, NamedModelElement, NamedProgramElement, NonTerminalProgramElement, ProgramElement, Reference, MemberReference, NameReference, PackageReferenceContainer, ReferencePrefix, ReferenceSuffix, TypeReference, TypeReferenceContainer, TypeReferenceInfix, SourceElement, SVSubstitute

Direct Known Subclasses:

SchemaTypeReference, TypeRef

public abstract class TypeReferenceImp
extends JavaNonTerminalProgramElement
implements TypeReference

TypeReferences reference Types by name. A TypeReference can refer to an outer or inner type and hence can also be a MemberReference, but does not have to. A TypeReference can also occur as part of a reference path and as a prefix for types, too. As a possible suffix for types, it can have other TypeReferences as a prefix, playing the role of a TypeReferenceContainer.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	dimensions Dimensions.
protected ProgramElementName	name Name.
protected ReferencePrefix	prefix Prefix.

Constructor Summary

Constructors

Constructor and Description
TypeReferenceImp(ExtList children, int dim) Constructor for the transformation of RECODER ASTs to KeY.
TypeReferenceImp(ProgramElementName name)
TypeReferenceImp(ProgramElementName name, int dimension, ReferencePrefix prefix)

Method Summary

Modifier and Type	Method and Description
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	getDimensions() Get dimensions.
Expression	getExpressionAt(int index)
int	getExpressionCount() Get the number of expressions in this container.
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
SourceElement	getFirstElementIncludingBlocks() Finds the source element that occurs first in the source.
abstract KeYJavaType	getKeYJavaType()
String	getName() Get name.
PackageReference	getPackageReference() Get the package reference.
ProgramElementName	getProgramElementName() Get identifier.
ReferencePrefix	getReferencePrefix() Get reference prefix.
TypeReference	getTypeReferenceAt(int index)
int	getTypeReferenceCount() Get the number of type references in this container.
MatchConditions	match(SourceData source, MatchConditions matchCond) matches the source "text" (@link SourceData#getSource()) against the pattern represented by this object.
void	prettyPrint(PrettyPrinter p) Pretty printing the source element.
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.java.JavaNonTerminalProgramElement

compatibleBlockSize, equals, equalsModRenaming, getArrayPos, hashCode, matchChildren

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

getComments, prettyPrintMain, reuseSignature

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

getEndPosition, 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.ProgramElement

getComments

Field Detail

prefix

protected ReferencePrefix prefix

Prefix.

dimensions

protected int dimensions

Dimensions.

name

protected ProgramElementName name

Name.

Constructor Detail

TypeReferenceImp

public TypeReferenceImp(ExtList children,
                        int dim)

Constructor for the transformation of RECODER ASTs to KeY.

Parameters:

children - the children of this AST element as KeY classes. May contain: a ReferencePrefix (as prefix of the type reference) a ProgramElementName (as name for the type reference) Comments

dim - the dimension of this type

TypeReferenceImp

public TypeReferenceImp(ProgramElementName name)

TypeReferenceImp

public TypeReferenceImp(ProgramElementName name,
                        int dimension,
                        ReferencePrefix prefix)

Method Detail

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

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

Overrides:

getFirstElementIncludingBlocks in class JavaSourceElement

Returns:

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

See Also:

SourceElement.getStartPosition()

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:

ArrayIndexOutOfBoundsException - if index is out of bounds

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

getExpressionCount

public int getExpressionCount()

Get the number of expressions in this container.

Specified by:

getExpressionCount in interface ExpressionContainer

Returns:

the number of expressions.

getExpressionAt

public Expression getExpressionAt(int index)

Specified by:

getExpressionAt in interface ExpressionContainer

getReferencePrefix

public ReferencePrefix getReferencePrefix()

Get reference prefix.

Specified by:

getReferencePrefix in interface ReferencePrefix

Specified by:

getReferencePrefix in interface TypeReference

Returns:

the reference prefix.

getPackageReference

public PackageReference getPackageReference()

Get the package reference.

Specified by:

getPackageReference in interface PackageReferenceContainer

Returns:

the package reference.

getDimensions

public int getDimensions()

Get dimensions.

Specified by:

getDimensions in interface TypeReference

Returns:

the int value.

getName

public final String getName()

Get name.

Specified by:

getName in interface NamedModelElement

Specified by:

getName in interface TypeReference

Returns:

the string.

getKeYJavaType

public abstract KeYJavaType getKeYJavaType()

Specified by:

getKeYJavaType in interface TypeReference

getProgramElementName

public ProgramElementName getProgramElementName()

Get identifier.

Specified by:

getProgramElementName in interface NamedProgramElement

Specified by:

getProgramElementName in interface TypeReference

Returns:

the identifier.

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 SourceElement

Parameters:

v - the Visitor

prettyPrint

public void prettyPrint(PrettyPrinter p)
                 throws IOException

Description copied from class: JavaSourceElement

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Overrides:

prettyPrint in class JavaProgramElement

Parameters:

p - a pretty printer.

Throws:

IOException - occasionally thrown.

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

Overrides:

match in class JavaNonTerminalProgramElement

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