de.uka.ilkd.key.java

Interface ProgramElement

All Superinterfaces:

ModelElement, SourceElement, SVSubstitute

All Known Subinterfaces:

AbstractProgramElement, Branch, ConstructorReference, Declaration, Expression, ExpressionContainer, ExpressionStatement, IExecutionContext, IForUpdates, IGuard, ILoopInit, IProgramMethod, IProgramVariable, Label, LoopInitializer, MemberDeclaration, MemberReference, MethodName, MethodOrConstructorReference, NamedProgramElement, NameReference, NonTerminalProgramElement, PackageReferenceContainer, ParameterContainer, ProgramConstruct, ProgramPrefix, ProgramVariableName, Reference, ReferencePrefix, ReferenceSuffix, ScopeDefiningElement, Statement, StatementContainer, TerminalProgramElement, TypeDeclarationContainer, TypeReference, TypeReferenceContainer, TypeReferenceInfix, TypeScope, VariableScope

All Known Implementing Classes:

Abstract, AbstractIntegerLiteral, AllFields, AllObjects, AnnotationUseSpecification, ArrayDeclaration, ArrayInitializer, ArrayLength, ArrayLengthReference, ArrayPostDecl, ArrayReference, Assert, Assignment, BinaryAnd, BinaryAndAssignment, BinaryNot, BinaryOperator, BinaryOr, BinaryOrAssignment, BinaryXOr, BinaryXOrAssignment, BooleanLiteral, BranchImp, BranchStatement, Break, Case, Catch, CatchAllStatement, CharLiteral, ClassDeclaration, ClassInitializer, ComparativeOperator, CompilationUnit, Conditional, ConstructorCall, ConstructorDeclaration, ContextStatementBlock, Continue, CopyAssignment, CreateObject, Default, Divide, DivideAssignment, DLEmbeddedExpression, Do, DoBreak, DoubleLiteral, Else, EmptyMapLiteral, EmptySeqLiteral, EmptySetLiteral, EmptyStatement, EnhancedFor, EnhancedForElimination, EnumClassDeclaration, Equals, EvaluateArgs, ExactInstanceof, ExecutionContext, ExpandMethodBody, ExpressionJumpStatement, Extends, FieldDeclaration, FieldReference, FieldSpecification, Final, Finally, FloatLiteral, For, ForInitUnfoldTransformer, ForToWhile, ForUpdates, FreeLiteral, Ghost, GreaterOrEquals, GreaterThan, Guard, If, Implements, ImplicitFieldSpecification, Import, InheritanceSpecification, InitArray, InitArrayCreation, Instanceof, InterfaceDeclaration, Intersect, IntLiteral, IsStatic, JavaDeclaration, JavaNonTerminalProgramElement, JavaProgramElement, JavaStatement, JumpStatement, LabeledStatement, LabelJumpStatement, LessOrEquals, LessThan, Literal, LocalVariableDeclaration, LocationVariable, LogicalAnd, LogicalNot, LogicalOr, LongLiteral, LoopInit, LoopScopeBlock, LoopStatement, MergePointStatement, MetaClassReference, MethodBodyStatement, MethodCall, MethodDeclaration, MethodFrame, MethodReference, Minus, MinusAssignment, Model, Modifier, Modulo, ModuloAssignment, MultipleVarDecl, Native, Negative, New, NewArray, NoState, NotEquals, NullLiteral, Operator, PackageReference, PackageSpecification, ParameterDeclaration, ParenthesizedExpression, PassiveExpression, Plus, PlusAssignment, Positive, PostDecrement, PostIncrement, PostWork, PreDecrement, PreIncrement, Private, ProgramConstant, ProgramElementName, ProgramMethod, ProgramSV, ProgramTransformer, ProgramVariable, Protected, Public, RealLiteral, Return, SchematicFieldReference, SchemaTypeReference, SeqConcat, SeqGet, SeqIndexOf, SeqLength, SeqReverse, SeqSingleton, SeqSub, SetMinus, SetUnion, ShiftLeft, ShiftLeftAssignment, ShiftRight, ShiftRightAssignment, Singleton, SpecialConstructorCall, SpecialConstructorReference, StatementBlock, Static, StaticInitialisation, StrictFp, StringLiteral, SuperArrayDeclaration, SuperConstructorReference, SuperReference, Switch, SwitchToIf, Synchronized, SynchronizedBlock, Then, ThisConstructorReference, ThisReference, Throw, Throws, Times, TimesAssignment, TransactionStatement, Transient, Try, TwoState, TypeCast, TypeDeclaration, TypeOf, TypeOperator, TypeRef, TypeReferenceImp, Unpack, UnsignedShiftRight, UnsignedShiftRightAssignment, UnwindLoop, VariableDeclaration, VariableNamer.IndProgramElementName, VariableNamer.PermIndProgramElementName, VariableNamer.TempIndProgramElementName, VariableReference, VariableSpecification, VisibilityModifier, Volatile, While

public interface ProgramElement
extends SourceElement, ModelElement

A part of the program syntax that carries semantics in the model. taken from COMPOST and changed to achieve an immutable structure

Method Summary

Modifier and Type	Method and Description
Comment[]	getComments() Get comments.
MatchConditions	match(SourceData source, MatchConditions matchCond) matches the source "text" (@link SourceData#getSource()) against the pattern represented by this object.

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

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

Method Detail

getComments

Comment[] getComments()

Get comments.

Returns:

the comments.

match

MatchConditions match(SourceData source,
                      MatchConditions matchCond)

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.

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