de.uka.ilkd.key.java.reference

Class SchematicFieldReference

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.VariableReference

de.uka.ilkd.key.java.reference.FieldReference

de.uka.ilkd.key.java.reference.SchematicFieldReference

All Implemented Interfaces:

Expression, ExpressionContainer, ModelElement, NamedModelElement, NamedProgramElement, NonTerminalProgramElement, ProgramElement, Reference, MemberReference, NameReference, ReferencePrefix, ReferenceSuffix, TypeReferenceContainer, SourceElement, SVSubstitute

public class SchematicFieldReference
extends FieldReference
implements MemberReference, ReferenceSuffix, TypeReferenceContainer, ExpressionContainer

Field reference.

Author:

AutoDoc

Field Summary

Fields

Modifier and Type	Field and Description
protected SchemaVariable	schemaVariable Reference suffix

Fields inherited from class de.uka.ilkd.key.java.reference.FieldReference

prefix

Fields inherited from class de.uka.ilkd.key.java.reference.VariableReference

variable

Constructor Summary

Constructors

Constructor and Description
SchematicFieldReference(ExtList children, ReferencePrefix prefix)
SchematicFieldReference(SchemaVariable pe, 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.
Expression	getExpressionAt(int index) Return the expression at the specified index in this node's "virtual" expression array.
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.
ProgramElementName	getProgramElementName() Get identifier.
ReferencePrefix	getReferencePrefix() Get reference prefix.
ReferenceSuffix	getReferenceSuffix() Get reference prefix.
TypeReference	getTypeReferenceAt(int index) Return the type reference at the specified index in this node's "virtual" type reference array.
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 print
ReferencePrefix	setReferencePrefix(ReferencePrefix rp) Set reference prefix.
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.reference.FieldReference

isSingleDeref, referencesOwnInstanceField

Methods inherited from class de.uka.ilkd.key.java.reference.VariableReference

getIdentifier, getKeYJavaType, getKeYJavaType, getKeYJavaType, getName, getProgramVariable

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

compatibleBlockSize, computeHashCode, equals, equalsModRenaming, getArrayPos, matchChildren

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

getComments, hashCode, 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

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

equalsModRenaming, getEndPosition, getLastElement, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

schemaVariable

protected final SchemaVariable schemaVariable

Reference suffix

Constructor Detail

SchematicFieldReference

public SchematicFieldReference(SchemaVariable pe,
                               ReferencePrefix prefix)

SchematicFieldReference

public SchematicFieldReference(ExtList children,
                               ReferencePrefix prefix)

Method Detail

getChildCount

public int getChildCount()

Returns the number of children of this node.

Specified by:

getChildCount in interface NonTerminalProgramElement

Overrides:

getChildCount in class FieldReference

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

Overrides:

getChildAt in class FieldReference

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

getReferencePrefix

public ReferencePrefix getReferencePrefix()

Get reference prefix.

Specified by:

getReferencePrefix in interface ReferencePrefix

Overrides:

getReferencePrefix in class FieldReference

Returns:

the reference prefix.

getReferenceSuffix

public ReferenceSuffix getReferenceSuffix()

Get reference prefix.

Returns:

the reference prefix.

setReferencePrefix

public ReferencePrefix setReferencePrefix(ReferencePrefix rp)

Set reference prefix.

Overrides:

setReferencePrefix in class FieldReference

getTypeReferenceCount

public int getTypeReferenceCount()

Get the number of type references in this container.

Specified by:

getTypeReferenceCount in interface TypeReferenceContainer

Overrides:

getTypeReferenceCount in class FieldReference

Returns:

the number of type references.

getTypeReferenceAt

public TypeReference getTypeReferenceAt(int index)

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

Specified by:

getTypeReferenceAt in interface TypeReferenceContainer

Overrides:

getTypeReferenceAt in class FieldReference

Parameters:

index - an index for a type reference.

Returns:

the type reference with the given index.

Throws:

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

getExpressionCount

public int getExpressionCount()

Get the number of expressions in this container.

Specified by:

getExpressionCount in interface ExpressionContainer

Overrides:

getExpressionCount in class FieldReference

Returns:

the number of expressions.

getExpressionAt

public Expression getExpressionAt(int index)

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

Specified by:

getExpressionAt in interface ExpressionContainer

Overrides:

getExpressionAt in class FieldReference

Parameters:

index - an index for an expression.

Returns:

the expression with the given index.

Throws:

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

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 FieldReference

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 FieldReference

Returns:

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

See Also:

SourceElement.getStartPosition()

getProgramElementName

public ProgramElementName getProgramElementName()

Description copied from interface: NamedProgramElement

Get identifier.

Specified by:

getProgramElementName in interface NamedProgramElement

Overrides:

getProgramElementName in class VariableReference

Returns:

the identifier.

prettyPrint

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

pretty print

Specified by:

prettyPrint in interface SourceElement

Overrides:

prettyPrint in class FieldReference

Parameters:

p - 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 SourceElement

Overrides:

visit in class FieldReference

Parameters:

v - the Visitor

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