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

Class IvmlOperationDescriptor

java.lang.Object

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

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

All Implemented Interfaces:

IMetaOperation

Direct Known Subclasses:

AbstractIvmlTypeOperationDescriptor, IvmlComparisonOperationDescriptor, IvmlConfigurationConversionOperationDescriptor, IvmlConfigurationOperationDescriptor, IvmlConstructorOperationDescriptor, IvmlConversionOperationDescriptor, IvmlOrderedEnumComparisonOperationDescriptor, IvmlOrderedEnumMinMaxOperationDescriptor, IvmlSequenceConversionOperationDescriptor, IvmlSetConversionOperationDescriptor

abstract class IvmlOperationDescriptor
extends OperationDescriptor

Implements a delegating operation descriptor, i.e., virtual operations representing access to IVML configuration data.

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
IvmlOperationDescriptor(TypeDescriptor<?> declaringType, java.lang.String name, boolean isConstructor)	Creates a new operation descriptor.

Method Summary

Modifier and Type	Method	Description
protected static <T> T	convertArgument(java.lang.Object arg, java.lang.Class<T> cls)	Converts an argument value to an instance of cls if possible.
protected static java.util.List<TypeDescriptor<?>>	createParameterList(TypeDescriptor<?> param)	Creates a parameter list for one parameter (type).
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).
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

Methods inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IMetaOperation

invoke, isCompatible

Constructor Detail

IvmlOperationDescriptor

IvmlOperationDescriptor(TypeDescriptor<?> declaringType,
                        java.lang.String name,
                        boolean isConstructor)

Creates a new operation descriptor. Overriding constructors shall call #setCharacteristics(OperationType, AliasType, boolean) in order to redefined the default values.

Parameters:

declaringType - the declaring type

name - the alias name (may be null if the original name of method shall be used)

isConstructor - whether the operation is a constructor

Method Detail

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

createParameterList

protected static java.util.List<TypeDescriptor<?>> createParameterList(TypeDescriptor<?> param)

Creates a parameter list for one parameter (type).

Parameters:

param - the parameter type

Returns:

the parameter list

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

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

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

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

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

convertArgument

protected static <T> T convertArgument(java.lang.Object arg,
                                       java.lang.Class<T> cls)

Converts an argument value to an instance of cls if possible.

Type Parameters:

T - the target type

Parameters:

arg - the argument value

cls - the target class

Returns:

a value of cls or null