Package net.ssehub.easy.instantiation.core.model.expressions

Class CallExpression

java.lang.Object

net.ssehub.easy.instantiation.core.model.expressions.Expression

net.ssehub.easy.instantiation.core.model.expressions.AbstractCallExpression

net.ssehub.easy.instantiation.core.model.expressions.CallExpression

All Implemented Interfaces:

IArgumentProvider

Direct Known Subclasses:

ConstructorCallExpression, StrategyCallExpression

public class CallExpression
extends AbstractCallExpression
implements IArgumentProvider

Represents a call to an operation of a TypeDescriptor. Please note that dot expressions shall be represented as nested call expressions, i.e., call(a).call(b).call(c) shall be represented as call(call(call(a), b), c) (set dotRight in the constructor).

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CallExpression.CallType	Defines some basic call types.

Field Summary

Fields

Modifier and Type	Field	Description
private CallArgument[]	arguments
private CallExpression.CallType	callType
private boolean	dotRight
private java.lang.Object	parent
private OperationDescriptor	resolved
private TypeDescriptor<?>	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CallExpression()	Constructor for serialization.
	CallExpression(java.lang.Object parent, java.lang.String name, boolean dotRight, CallArgument... arguments)	Creates a new call expression which may be part of a dot expression.
	CallExpression(java.lang.Object parent, java.lang.String name, CallArgument... arguments)	Creates a new (undotted) call expression.
	CallExpression(java.lang.Object parent, java.lang.String name, Expression... arguments)	Creates a new (undotted) call expression.
	CallExpression(IMetaOperation operation, CallArgument... param)	Creates a new transparent call expression from a conversion or optimization operation.
	CallExpression(OperationDescriptor operation, CallArgument arg)	Creates a new transparent call expression from a conversion or optimization operation.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accept(IExpressionVisitor visitor)	Visits the expression.
protected boolean	checkMetaForFirstArgField()	Returns whether the field meta type shall be checked in #resolveOperation().
private TypeDescriptor<?>[]	checkUseParameter()	Checks whether one of the parameter / argument types shall be used.
private TypeDescriptor<?>	considerIteratorResult(TypeDescriptor<?> result)	Considers the potential explicit result type of an iterator.
private TypeDescriptor<?>	considerReturnGenerics(TypeDescriptor<?> type, TypeDescriptor<?>[] returnGenerics)	Considers the return generics on type.
protected TypeDescriptor<?>	determineOperand()	Determines the operand for searching operations on.
protected boolean	doZeroArgumentTest()	Returns whether the zero argument test shall be applied.
CallArgument	getArgument(int index)	Returns the specified argument.
int	getArgumentsCount()	Returns the number of arguments.
CallExpression.CallType	getCallType()	Returns the call type.
java.lang.Object	getParent()	Returns the parent language unit.
OperationDescriptor	getResolved()	Returns the resolved operation.
java.lang.String	getVilSignature()	Returns the VIL signature of the resolved operation.
TypeDescriptor<?>	inferType()	Infers the type of this expression including the type of the contained sub-expressions.
boolean	isDotRightExpression()	Returns whether this expression occurred on the right side of a dot expression (decompose while writing).
boolean	isIteratingCollectionOperation()	Returns whether this operation is a collection-iterator operation.
boolean	isIteratorCall()	Returns whether this call is an iterator call.
boolean	isOclCompliant()	Returns whether this operation is OCL compliant or flagged as not compliant.
boolean	isPlaceholder()	Returns whether this operation is a placeholder, i.e., either the resolved operation is a placeholder, its signature or its return type does contain a placeholder type.

Methods inherited from class net.ssehub.easy.instantiation.core.model.expressions.AbstractCallExpression

dynamicDispatch, getName, getParameterType, getPrefix, getQualifiedName, getSignature, getVilSignature, isPlaceholder, resolveOperation, resolveOperation, resolveResolvableOperation

Methods inherited from class net.ssehub.easy.instantiation.core.model.expressions.Expression

replaceEmptyLine

Methods inherited from class java.lang.Object

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

Field Detail

parent

private java.lang.Object parent

arguments

private CallArgument[] arguments

resolved

private OperationDescriptor resolved

type

private TypeDescriptor<?> type

callType

private CallExpression.CallType callType

dotRight

private boolean dotRight

Constructor Detail

CallExpression

protected CallExpression()
                  throws VilException

Constructor for serialization.

Throws:

VilException - shall not occur

CallExpression

public CallExpression(java.lang.Object parent,
                      java.lang.String name,
                      Expression... arguments)
               throws VilException

Creates a new (undotted) call expression.

Parameters:

parent - the parent language unit (if given used as optional parameter during calls)

name - the name of the call

arguments - the arguments for the call

Throws:

VilException - in case that no argument is given

CallExpression

public CallExpression(java.lang.Object parent,
                      java.lang.String name,
                      CallArgument... arguments)
               throws VilException

Creates a new (undotted) call expression.

Parameters:

parent - the parent language unit (if given used as optional parameter during calls)

name - the name of the call.

arguments - the arguments for the call

Throws:

VilException - in case that no argument is given

CallExpression

public CallExpression(java.lang.Object parent,
                      java.lang.String name,
                      boolean dotRight,
                      CallArgument... arguments)
               throws VilException

Creates a new call expression which may be part of a dot expression.

Parameters:

parent - the parent language unit (if given used as optional parameter during calls)

name - the name of the call

dotRight - if this expression occurred on the right side of a "."

arguments - the arguments for the call

Throws:

VilException - in case that no argument is given

CallExpression

public CallExpression(OperationDescriptor operation,
                      CallArgument arg)
               throws VilException

Creates a new transparent call expression from a conversion or optimization operation.

Parameters:

operation - the operation to be considered

arg - the one and only argument

Throws:

VilException - in case that the operation does not exactly take one argument and provide a result

CallExpression

public CallExpression(IMetaOperation operation,
                      CallArgument... param)
               throws VilException

Creates a new transparent call expression from a conversion or optimization operation.

Parameters:

operation - the operation to be considered

param - the one and only parameter

Throws:

VilException - in case that the operation does not exactly take one argument and provide a result

Method Detail

getParent

public java.lang.Object getParent()

Returns the parent language unit.

Returns:

the parent language unit (may be null if not given or implicit operation)

doZeroArgumentTest

protected boolean doZeroArgumentTest()

Returns whether the zero argument test shall be applied.

Returns:

true if the test shall be applied, false else

isDotRightExpression

public boolean isDotRightExpression()

Returns whether this expression occurred on the right side of a dot expression (decompose while writing).

Returns:

true if it appeared on the right side, false else

getResolved

public OperationDescriptor getResolved()

Returns the resolved operation.

Returns:

the resolved operation

getCallType

public CallExpression.CallType getCallType()

Returns the call type.

Returns:

the call type

determineOperand

protected TypeDescriptor<?> determineOperand()
                                      throws VilException

Determines the operand for searching operations on. Is called by inferType().

Returns:

the operand

Throws:

VilException - in case that determining the operand fails

checkMetaForFirstArgField

protected boolean checkMetaForFirstArgField()

Returns whether the field meta type shall be checked in #resolveOperation().

Returns:

true

checkUseParameter

private TypeDescriptor<?>[] checkUseParameter()
                                       throws VilException

Checks whether one of the parameter / argument types shall be used.

Returns:

the parameter type or null

Throws:

VilException - in case of type problems

inferType

public TypeDescriptor<?> inferType()
                            throws VilException

Description copied from class: Expression

Infers the type of this expression including the type of the contained sub-expressions.

Specified by:

inferType in class Expression

Returns:

the type of this expression

Throws:

VilException - in case that inferring the type fails

considerReturnGenerics

private TypeDescriptor<?> considerReturnGenerics(TypeDescriptor<?> type,
                                                 TypeDescriptor<?>[] returnGenerics)

Considers the return generics on type.

Parameters:

type - the type to consider the generics for

returnGenerics - the return generics (may be null)

Returns:

the resulting descriptor or type if no return generics are given

getArgumentsCount

public int getArgumentsCount()

Returns the number of arguments.

Specified by:

getArgumentsCount in interface IArgumentProvider

Specified by:

getArgumentsCount in class AbstractCallExpression

Returns:

the number of arguments

getArgument

public CallArgument getArgument(int index)

Returns the specified argument.

Specified by:

getArgument in interface IArgumentProvider

Specified by:

getArgument in class AbstractCallExpression

Parameters:

index - the index of the argument to be returned

Returns:

the argument

Throws:

java.lang.IndexOutOfBoundsException - in case of index < 0 || index >= getArgumentsCount().

isPlaceholder

public boolean isPlaceholder()

Description copied from class: AbstractCallExpression

Returns whether this operation is a placeholder, i.e., either the resolved operation is a placeholder, its signature or its return type does contain a placeholder type.

Specified by:

isPlaceholder in class AbstractCallExpression

Returns:

true if this operation is a placeholder and cannot be executed, false else

accept

public java.lang.Object accept(IExpressionVisitor visitor)
                        throws VilException

Description copied from class: Expression

Visits the expression.

Specified by:

accept in class Expression

Parameters:

visitor - the visitor

Returns:

the result of visiting this expression (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

getVilSignature

public java.lang.String getVilSignature()

Description copied from class: AbstractCallExpression

Returns the VIL signature of the resolved operation.

Specified by:

getVilSignature in class AbstractCallExpression

Returns:

the VIL signature

isIteratorCall

public boolean isIteratorCall()

Returns whether this call is an iterator call.

Returns:

true if it is an iterator call, false else

considerIteratorResult

private TypeDescriptor<?> considerIteratorResult(TypeDescriptor<?> result)
                                          throws VilException

Considers the potential explicit result type of an iterator.

Parameters:

result - the result type so far

Returns:

the result type

Throws:

VilException - if aggregation shall be applied to a non-aggregating iterator operation

isOclCompliant

public boolean isOclCompliant()

Description copied from class: AbstractCallExpression

Returns whether this operation is OCL compliant or flagged as not compliant.

Overrides:

isOclCompliant in class AbstractCallExpression

Returns:

true for compliant, false else

isIteratingCollectionOperation

public boolean isIteratingCollectionOperation()

Description copied from class: AbstractCallExpression

Returns whether this operation is a collection-iterator operation.

Overrides:

isIteratingCollectionOperation in class AbstractCallExpression

Returns:

true for collection-iterator, false else