org.eclipse.ocl.utilities

Class AbstractVisitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

java.lang.Object

org.eclipse.ocl.utilities.AbstractVisitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

All Implemented Interfaces:

Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

Direct Known Subclasses:

AbstractEvaluationVisitor, AbstractVisitor, ToStringVisitor

public abstract class AbstractVisitor<T,C,O,P,EL,PM,S,COA,SSA,CT>
extends Object
implements Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

An abstract implementation of the Visitor API, in which subclasses need only selectively override handleXxx(...) methods for internal AST nodes and visitXxx(...) methods for leaf nodes.

The result value is convenient for accumulating the result of the visitation. In the subclass, simply assign/modify the result value as necessary in the overridden visitation methods, and this framework will ensure that it is returned as the overall value of the Visitable.accept(Visitor) call.

Author:

Christian W. Damus (cdamus)

Method Summary

Modifier and Type	Method and Description
T	visitAssociationClassCallExp(AssociationClassCallExp<C,P> callExp) Visits the association-class-call source and then its qualifiers (if any).
T	visitBooleanLiteralExp(BooleanLiteralExp<C> literalExp) Simply returns result.
T	visitCollectionItem(CollectionItem<C> item) Visits the item's item expression.
T	visitCollectionLiteralExp(CollectionLiteralExp<C> literalExp) Visits the collection literal's parts.
T	visitCollectionRange(CollectionRange<C> range) Visits the range's first and last expressions.
T	visitConstraint(CT constraint) Visits the constraint's specification, if any (and if the getSpecification(Object) method is overridden).
T	visitEnumLiteralExp(EnumLiteralExp<C,EL> literalExp) Simply returns result.
T	visitExpressionInOCL(ExpressionInOCL<C,PM> expression) Visits the expressions context variable, its parameter variables (if any), its result variable (if any), and finally its body expression.
T	visitIfExp(IfExp<C> ifExp) Visits the if expression's condition, then, and else expressions.
T	visitIntegerLiteralExp(IntegerLiteralExp<C> literalExp) Simply returns result.
T	visitInvalidLiteralExp(InvalidLiteralExp<C> literalExp) Simply returns result.
T	visitIterateExp(IterateExp<C,PM> callExp) Visits the iterate's source, then its iterator variables, result variable, and body expression.
T	visitIteratorExp(IteratorExp<C,PM> callExp) Visits the iterator's source, then its variables, followed by its body expression.
T	visitLetExp(LetExp<C,PM> letExp) Visits the let's variable declaration then its 'in' expression.
T	visitMessageExp(MessageExp<C,COA,SSA> messageExp) Visits the message expression's target and then its arguments.
T	visitNullLiteralExp(NullLiteralExp<C> literalExp) Simply returns result.
T	visitOperationCallExp(OperationCallExp<C,O> callExp) Visits the operation-call source and then its arguments.
T	visitPropertyCallExp(PropertyCallExp<C,P> callExp) Visits the property-call source and then its qualifiers (if any).
T	visitRealLiteralExp(RealLiteralExp<C> literalExp) Simply returns result.
T	visitStateExp(StateExp<C,S> stateExp) Simply returns result.
T	visitStringLiteralExp(StringLiteralExp<C> literalExp) Simply returns result.
T	visitTupleLiteralExp(TupleLiteralExp<C,P> literalExp) Visits the tuple literal's parts.
T	visitTupleLiteralPart(TupleLiteralPart<C,P> part) Visits the tuple literal part's value, if any.
T	visitTypeExp(TypeExp<C> t) Simply returns result.
T	visitUnlimitedNaturalLiteralExp(UnlimitedNaturalLiteralExp<C> literalExp) Simply returns result.
T	visitUnspecifiedValueExp(UnspecifiedValueExp<C> unspecExp) Simply returns result.
T	visitVariable(Variable<C,PM> variable) Visits the variable's initialization expression (if any).
T	visitVariableExp(VariableExp<C,PM> v) Simply returns result.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

visitOperationCallExp

public T visitOperationCallExp(OperationCallExp<C,O> callExp)

Visits the operation-call source and then its arguments. Returns the result of handleOperationCallExp(OperationCallExp, Object, List).

Specified by:

visitOperationCallExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitVariableExp

public T visitVariableExp(VariableExp<C,PM> v)

Simply returns result.

Specified by:

visitVariableExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitPropertyCallExp

public T visitPropertyCallExp(PropertyCallExp<C,P> callExp)

Visits the property-call source and then its qualifiers (if any). Returns the result of handlePropertyCallExp(PropertyCallExp, Object, List).

Specified by:

visitPropertyCallExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitAssociationClassCallExp

public T visitAssociationClassCallExp(AssociationClassCallExp<C,P> callExp)

Visits the association-class-call source and then its qualifiers (if any). Returns the result of handleAssociationClassCallExp(AssociationClassCallExp, Object, List).

Specified by:

visitAssociationClassCallExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitVariable

public T visitVariable(Variable<C,PM> variable)

Visits the variable's initialization expression (if any). Returns the result of handleVariable(Variable, Object).

Specified by:

visitVariable in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitIfExp

public T visitIfExp(IfExp<C> ifExp)

Visits the if expression's condition, then, and else expressions. Returns the result of handleIfExp(IfExp, Object, Object, Object).

Specified by:

visitIfExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitTypeExp

public T visitTypeExp(TypeExp<C> t)

Simply returns result.

Specified by:

visitTypeExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitMessageExp

public T visitMessageExp(MessageExp<C,COA,SSA> messageExp)

Visits the message expression's target and then its arguments. Returns the result of handleMessageExp(MessageExp, Object, List).

Specified by:

visitMessageExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitUnspecifiedValueExp

public T visitUnspecifiedValueExp(UnspecifiedValueExp<C> unspecExp)

Simply returns result.

Specified by:

visitUnspecifiedValueExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitStateExp

public T visitStateExp(StateExp<C,S> stateExp)

Simply returns result.

Specified by:

visitStateExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitIntegerLiteralExp

public T visitIntegerLiteralExp(IntegerLiteralExp<C> literalExp)

Simply returns result.

Specified by:

visitIntegerLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitUnlimitedNaturalLiteralExp

public T visitUnlimitedNaturalLiteralExp(UnlimitedNaturalLiteralExp<C> literalExp)

Simply returns result.

Specified by:

visitUnlimitedNaturalLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitRealLiteralExp

public T visitRealLiteralExp(RealLiteralExp<C> literalExp)

Simply returns result.

Specified by:

visitRealLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitStringLiteralExp

public T visitStringLiteralExp(StringLiteralExp<C> literalExp)

Simply returns result.

Specified by:

visitStringLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitBooleanLiteralExp

public T visitBooleanLiteralExp(BooleanLiteralExp<C> literalExp)

Simply returns result.

Specified by:

visitBooleanLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitNullLiteralExp

public T visitNullLiteralExp(NullLiteralExp<C> literalExp)

Simply returns result.

Specified by:

visitNullLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitInvalidLiteralExp

public T visitInvalidLiteralExp(InvalidLiteralExp<C> literalExp)

Simply returns result.

Specified by:

visitInvalidLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitTupleLiteralExp

public T visitTupleLiteralExp(TupleLiteralExp<C,P> literalExp)

Visits the tuple literal's parts. Returns the result of handleTupleLiteralExp(TupleLiteralExp, List).

Specified by:

visitTupleLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitTupleLiteralPart

public T visitTupleLiteralPart(TupleLiteralPart<C,P> part)

Visits the tuple literal part's value, if any. Returns the result of handleTupleLiteralPart(TupleLiteralPart, Object).

Specified by:

visitTupleLiteralPart in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitLetExp

public T visitLetExp(LetExp<C,PM> letExp)

Visits the let's variable declaration then its 'in' expression. Returns the result of handleLetExp(LetExp, Object, Object).

Specified by:

visitLetExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitEnumLiteralExp

public T visitEnumLiteralExp(EnumLiteralExp<C,EL> literalExp)

Simply returns result.

Specified by:

visitEnumLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitCollectionLiteralExp

public T visitCollectionLiteralExp(CollectionLiteralExp<C> literalExp)

Visits the collection literal's parts. Returns the result of handleCollectionLiteralExp(CollectionLiteralExp, List).

Specified by:

visitCollectionLiteralExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitCollectionItem

public T visitCollectionItem(CollectionItem<C> item)

Visits the item's item expression. Returns the result of handleCollectionItem(CollectionItem, Object)

Specified by:

visitCollectionItem in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitCollectionRange

public T visitCollectionRange(CollectionRange<C> range)

Visits the range's first and last expressions. Returns the result of handleCollectionRange(CollectionRange, Object, Object).

Specified by:

visitCollectionRange in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitIteratorExp

public T visitIteratorExp(IteratorExp<C,PM> callExp)

Visits the iterator's source, then its variables, followed by its body expression. Returns the result of handleIteratorExp(IteratorExp, Object, List, Object).

Specified by:

visitIteratorExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitIterateExp

public T visitIterateExp(IterateExp<C,PM> callExp)

Visits the iterate's source, then its iterator variables, result variable, and body expression. Returns the result of handleIterateExp(IterateExp, Object, List, Object, Object).

Specified by:

visitIterateExp in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitExpressionInOCL

public T visitExpressionInOCL(ExpressionInOCL<C,PM> expression)

Visits the expressions context variable, its parameter variables (if any), its result variable (if any), and finally its body expression. Returns the result of handleExpressionInOCL(ExpressionInOCL, Object, Object, List, Object).

Specified by:

visitExpressionInOCL in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

visitConstraint

public T visitConstraint(CT constraint)

Visits the constraint's specification, if any (and if the getSpecification(Object) method is overridden). Returns the result of handleConstraint(Object, Object).

Specified by:

visitConstraint in interface Visitor<T,C,O,P,EL,PM,S,COA,SSA,CT>

See Also:

getSpecification(Object)