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

Class IvmlConversionOperationDescriptor

java.lang.Object

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

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

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

All Implemented Interfaces:

IMetaOperation

Direct Known Subclasses:

IvmlToStringConversionOperationDescriptor

public class IvmlConversionOperationDescriptor
extends IvmlOperationDescriptor

Defines an operation descriptor which enables comfortable access to an individual decision variables via its name.

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

Modifier and Type	Field	Description
static java.lang.String	NAME

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

CONSTRUCTOR_NAME, EMPTY_PARAMETER

Constructor Summary

Constructors

Constructor	Description
IvmlConversionOperationDescriptor()	Constructor for serialization.
IvmlConversionOperationDescriptor(TypeDescriptor<?> declaringType)	Creates the operation descriptor.
IvmlConversionOperationDescriptor(TypeDescriptor<?> declaringType, TypeDescriptor<?> returnType)	Creates the operation descriptor.

Method Summary

Modifier and Type	Method	Description
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.

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

convertArgument, createParameterList, getDeclaringTypeNameFallback, getJavaSignature, initializeParameters, initializeReturnType, isFirstParameterOperand, isPlaceholder, isStatic, storeArtifactsBeforeExecution, useGenericParameterAsReturn, useParameterAsReturn

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

IvmlConversionOperationDescriptor

IvmlConversionOperationDescriptor()

Constructor for serialization.

IvmlConversionOperationDescriptor

IvmlConversionOperationDescriptor(TypeDescriptor<?> declaringType)

Creates the operation descriptor.

Parameters:

declaringType - the declaring type

IvmlConversionOperationDescriptor

IvmlConversionOperationDescriptor(TypeDescriptor<?> declaringType,
                                  TypeDescriptor<?> returnType)

Creates the operation descriptor.

Parameters:

declaringType - the declaring type

returnType - the return type

Method Detail

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