Package net.ssehub.easy.instantiation.core.model.vilTypes.configuration

Class FakeOperationDescriptor

java.lang.Object

net.ssehub.easy.instantiation.core.model.vilTypes.OperationDescriptor

net.ssehub.easy.instantiation.core.model.vilTypes.configuration.FakeOperationDescriptor

All Implemented Interfaces:

IMetaOperation

public class FakeOperationDescriptor
extends OperationDescriptor

Represents a fake operation descriptor, i.e., an operation which accepts every type of parameter and the result can be used everywhere.

Author:

Holger Eichelberger

Nested Class Summary

Nested classes/interfaces inherited from class net.ssehub.easy.instantiation.core.model.vilTypes.OperationDescriptor

OperationDescriptor.AliasType

Nested classes/interfaces inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IMetaOperation

IMetaOperation.CompatibilityResult

Field Summary

Fields inherited from class net.ssehub.easy.instantiation.core.model.vilTypes.OperationDescriptor

CONSTRUCTOR_NAME, EMPTY_PARAMETER

Constructor Summary

Constructors

Constructor	Description
FakeOperationDescriptor(TypeDescriptor<?> declaringType, java.lang.String name, int parameterCount, boolean acceptsNamedParameters)	Create a fake operation descriptor.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getDeclaringTypeNameFallback()	Returns the name of the declaring type in case that OperationDescriptor.getDeclaringType() is null.
java.lang.String	getJavaSignature()	Returns the Java signature of the method (public for testing).
protected void	initializeParameters()	Initializes the parameters (lazy init).
protected void	initializeReturnType()	Initializes the return type (lazy init).
java.lang.Object	invoke(java.lang.Object... args)	Invokes the specified operation.
IMetaOperation.CompatibilityResult	isCompatible(java.lang.Class<?> retType, java.lang.Object... params)	Returns whether the operation represented by this instance is compatible to the given return type and parameters.
boolean	isFirstParameterOperand()	Returns whether the first parameter is the operand.
boolean	isPlaceholder()	Returns whether this operation is valid or whether it is a placeholder operation in case that the original operation cannot be resolved but the script shall remain executable.
boolean	isStatic()	Returns whether this operation is static.
boolean	storeArtifactsBeforeExecution()	Returns whether artifacts shall be stored before execution of this operation.
int	useGenericParameterAsReturn()	Returns whether a generc parameter of the operand shall be used as return type.
int	useParameterAsReturn()	Returns whether a parameter shall be used as return type.

Methods inherited from class net.ssehub.easy.instantiation.core.model.vilTypes.OperationDescriptor

acceptsImplicitParameters, acceptsNamedParameters, allowsAggregation, composeExceptionMessage, convertVariables, flatten, getAliasType, getDeclaringType, getDeclaringTypeName, getName, getOperationType, getParameter, getParameter, getParameterCount, getParameterType, getRequiredParameterCount, getReturnType, getSignature, getStoredName, isAlias, isConstructor, isConstructor, isConversion, isGenericCollectionOperation, isIteratingCollectionOperation, isOclCompliant, isOperation, isSameSignature, isTypeSelect, requiresDynamicExpressionProcessing, setCharacteristics, setParameters, setReturnType, specializeFor, throwIncompatibleParameter, toString, trace, useAny, useOperandTypeAsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

FakeOperationDescriptor

FakeOperationDescriptor(TypeDescriptor<?> declaringType,
                        java.lang.String name,
                        int parameterCount,
                        boolean acceptsNamedParameters)

Create a fake operation descriptor.

Parameters:

declaringType - the declaring type

name - the name of the operation

parameterCount - the number of parameters of the operation

acceptsNamedParameters - whether the operation accepts named parameters

Method Detail

isStatic

public boolean isStatic()

Description copied from interface: IMetaOperation

Returns whether this operation is static.

Returns:

true if it is static, false else

isFirstParameterOperand

public boolean isFirstParameterOperand()

Description copied from interface: IMetaOperation

Returns whether the first parameter is the operand.

Returns:

true if the first parameter is the operand, false else

isPlaceholder

public boolean isPlaceholder()

Description copied from interface: IMetaOperation

Returns whether this operation is valid or whether it is a placeholder operation in case that the original operation cannot be resolved but the script shall remain executable.

Returns:

true if this operation is a placeholder, false else

initializeParameters

protected void initializeParameters()

Description copied from class: OperationDescriptor

Initializes the parameters (lazy init). Is called by OperationDescriptor.initialize(). Shall call OperationDescriptor.setParameters(List, boolean, boolean).

Specified by:

initializeParameters in class OperationDescriptor

initializeReturnType

protected void initializeReturnType()

Description copied from class: OperationDescriptor

Initializes the return type (lazy init). Is called by OperationDescriptor.initialize(). Shall call OperationDescriptor.setReturnType(TypeDescriptor).

Specified by:

initializeReturnType in class OperationDescriptor

getDeclaringTypeNameFallback

protected java.lang.String getDeclaringTypeNameFallback()

Description copied from class: OperationDescriptor

Returns the name of the declaring type in case that OperationDescriptor.getDeclaringType() is null.

Specified by:

getDeclaringTypeNameFallback in class OperationDescriptor

Returns:

the name of the declaring type

getJavaSignature

public java.lang.String getJavaSignature()

Description copied from class: OperationDescriptor

Returns the Java signature of the method (public for testing).

Specified by:

getJavaSignature in interface IMetaOperation

Specified by:

getJavaSignature in class OperationDescriptor

Returns:

the Java signature of the method

isCompatible

public IMetaOperation.CompatibilityResult isCompatible(java.lang.Class<?> retType,
                                                       java.lang.Object... params)

Description copied from interface: IMetaOperation

Returns whether the operation represented by this instance is compatible to the given return type and parameters. This method does not consider possible unnamed parameter rather than the underlying Java parameter.

Parameters:

retType - the return type (may be null in order to ignore this parameter)

params - the parameters (may be null if there are none, may be classes)

Returns:

an instance of IMetaOperation.CompatibilityResult denoting the actual compatibility level

invoke

public java.lang.Object invoke(java.lang.Object... args)
                        throws VilException

Description copied from interface: IMetaOperation

Invokes the specified operation. This method does not consider possible unnamed parameter rather than the underlying Java parameter. In case of IMetaOperation.acceptsNamedParameters() the caller must ensure that the last parameter is a map<String, Object> containing the named parameters.

Parameters:

args - the arguments, in case of non-static operations the first argument must be the object to execute on

Returns:

the result of the execution

Throws:

VilException - if the invocation fails

See Also:

IMetaOperation.isCompatible(java.lang.Class<?>, java.lang.Object...)

useGenericParameterAsReturn

public int useGenericParameterAsReturn()

Description copied from class: OperationDescriptor

Returns whether a generc parameter of the operand shall be used as return type.

Specified by:

useGenericParameterAsReturn in class OperationDescriptor

Returns:

the parameter to be used as index number, negative if none

useParameterAsReturn

public int useParameterAsReturn()

Description copied from class: OperationDescriptor

Returns whether a parameter shall be used as return type.

Specified by:

useParameterAsReturn in class OperationDescriptor

Returns:

the parameter to be used as index number, negative if none

storeArtifactsBeforeExecution

public boolean storeArtifactsBeforeExecution()

Description copied from class: OperationDescriptor

Returns whether artifacts shall be stored before execution of this operation.

Specified by:

storeArtifactsBeforeExecution in class OperationDescriptor

Returns:

true if artifacts shall be stored, false else