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

Class Def

java.lang.Object

net.ssehub.easy.instantiation.core.model.templateModel.AbstractTemplateElement

net.ssehub.easy.instantiation.core.model.templateModel.TemplateBlock

net.ssehub.easy.instantiation.core.model.templateModel.Def

All Implemented Interfaces:

ILanguageElement, IParameterizable<VariableDeclaration>, IResolvableOperation<VariableDeclaration>, ITemplateElement, ITemplateLangElement, IMetaOperation, IStringValueProvider

public class Def
extends TemplateBlock
implements ITemplateLangElement, IResolvableOperation<VariableDeclaration>, IStringValueProvider

Implements a template language subtemplate ('def').

Author:

Holger Eichelberger

Nested Class Summary

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

IMetaOperation.CompatibilityResult

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

IStringValueProvider.StringComparator

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isProtected
private java.lang.String	name
private java.util.Map<java.lang.String,VariableDeclaration>	namedParam
private VariableDeclaration[]	param
private Template	parent
private TypeDescriptor<?>	specifiedType

Constructor Summary

Constructors

Constructor	Description
Def()	Constructor for serialization.
Def(java.lang.String name, VariableDeclaration[] param, ITemplateElement[] body, TypeDescriptor<?> specifiedType, Template parent)	Creates a new sub-template ('def').

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accept(IVisitor visitor)	Accepts the visitor for visiting.
boolean	acceptsNamedParameters()	Returns whether the operation accepts named parameters.
private boolean	checkEmptyContainerIntializerCompliance(TypeDescriptor<?> result, TypeDescriptor<?> specifiedType)	Checks the given inferred result type and the specified result type specifiedType for type compliance against direct return of an empty container initializer.
IMetaType	getDeclaringType()	Returns the declaring type.
java.lang.String	getJavaSignature()	Returns the java-like signature of this operation.
java.lang.String	getName()	Returns the name of this template.
VariableDeclaration	getParameter(int index)	Get the parameter of this rule at the specified index.
VariableDeclaration	getParameter(java.lang.String name)	Returns a named parameter declaration.
int	getParameterCount()	Get the number of parameters of this rule.
IMetaType	getParameterType(int index)	Returns the specified parameter type.
int	getRequiredParameterCount()	Returns the number of required parameters, i.e., non-default and non-named parameters.
TypeDescriptor<?>	getReturnType()	Returns the return type of this operation.
java.lang.String	getSignature()	Returns the signature of the method (in terms of VIL types where possible).
TypeDescriptor<?>	getSpecifiedType()	The specified type.
java.lang.String	getStringValue(IStringValueProvider.StringComparator comparator)	Returns the string value of this object.
TypeDescriptor<?>	inferType()	Infers the type of this language element.
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	isConstructor()	Returns whether this operation represents a constructor.
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	isProtected()	Returns whether this Def is protected in visibility.
boolean	isStatic()	Returns whether this operation is static.
protected void	setParent(ILanguageElement parent)	Changes the parent.
void	setProtected(boolean isProtected)	Changes whether this Def is protected in visibility.
java.lang.String	toString()

Methods inherited from class net.ssehub.easy.instantiation.core.model.templateModel.TemplateBlock

endsWithContentStatement, getBodyElement, getBodyElementCount, getTypeDefiningElement, isBlock, setBody

Methods inherited from class net.ssehub.easy.instantiation.core.model.templateModel.AbstractTemplateElement

getParent

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.common.ILanguageElement

getParent

Field Detail

parent

private Template parent

name

private java.lang.String name

param

private VariableDeclaration[] param

namedParam

private java.util.Map<java.lang.String,VariableDeclaration> namedParam

specifiedType

private TypeDescriptor<?> specifiedType

isProtected

private boolean isProtected

Constructor Detail

Def

Def()

Constructor for serialization.

Def

public Def(java.lang.String name,
           VariableDeclaration[] param,
           ITemplateElement[] body,
           TypeDescriptor<?> specifiedType,
           Template parent)

Creates a new sub-template ('def').

Parameters:

name - the name of the template

param - the parameter of the template (may be null)

body - the body elements (may be null)

parent - the declaring template

specifiedType - the specified type (may be null if none is given)

Method Detail

isProtected

public boolean isProtected()

Returns whether this Def is protected in visibility.

Returns:

true if it is protected, false else

setProtected

public void setProtected(boolean isProtected)

Changes whether this Def is protected in visibility.

Parameters:

isProtected - true if it is protected, false else

getName

public java.lang.String getName()

Returns the name of this template.

Specified by:

getName in interface IMetaOperation

Returns:

the name

getSpecifiedType

public TypeDescriptor<?> getSpecifiedType()

The specified type. For the actual type see inferType().

Returns:

the specified type, may be null if none is given

getParameterCount

public int getParameterCount()

Description copied from interface: IParameterizable

Get the number of parameters of this rule.

Specified by:

getParameterCount in interface IMetaOperation

Specified by:

getParameterCount in interface IParameterizable<VariableDeclaration>

Returns:

The number of parameters of this rule.

getParameter

public VariableDeclaration getParameter(int index)

Description copied from interface: IParameterizable

Get the parameter of this rule at the specified index.

Specified by:

getParameter in interface IParameterizable<VariableDeclaration>

Parameters:

index - The 0-based index of the rule parameter to be returned.

Returns:

The rule parameter at the given index.

getRequiredParameterCount

public int getRequiredParameterCount()

Description copied from interface: IParameterizable

Returns the number of required parameters, i.e., non-default and non-named parameters.

Specified by:

getRequiredParameterCount in interface IMetaOperation

Specified by:

getRequiredParameterCount in interface IParameterizable<VariableDeclaration>

Returns:

the number of required parameters

getParameter

public VariableDeclaration getParameter(java.lang.String name)

Description copied from interface: IParameterizable

Returns a named parameter declaration.

Specified by:

getParameter in interface IMetaOperation

Specified by:

getParameter in interface IParameterizable<VariableDeclaration>

Parameters:

name - the name of the parameter

Returns:

the declaration or null if there is none

accept

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

Description copied from interface: ITemplateLangElement

Accepts the visitor for visiting.

Specified by:

accept in interface ITemplateLangElement

Overrides:

accept in class TemplateBlock

Parameters:

visitor - the visitor to be used

Returns:

the result of visiting this instance (may be null)

Throws:

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

getParameterType

public IMetaType getParameterType(int index)

Description copied from interface: IMetaOperation

Returns the specified parameter type.

Specified by:

getParameterType in interface IMetaOperation

Parameters:

index - the index of the parameter to return

Returns:

the specified parameter type

getJavaSignature

public java.lang.String getJavaSignature()

Description copied from interface: IMetaOperation

Returns the java-like signature of this operation.

Specified by:

getJavaSignature in interface IMetaOperation

Returns:

the java-like Java signature of this operation

getSignature

public java.lang.String getSignature()

Description copied from interface: IMetaOperation

Returns the signature of the method (in terms of VIL types where possible).

Specified by:

getSignature in interface IMetaOperation

Returns:

the signature of the method

getReturnType

public TypeDescriptor<?> getReturnType()

Description copied from interface: IResolvableOperation

Returns the return type of this operation.

Specified by:

getReturnType in interface IMetaOperation

Specified by:

getReturnType in interface IResolvableOperation<VariableDeclaration>

Returns:

the return type

acceptsNamedParameters

public boolean acceptsNamedParameters()

Description copied from interface: IMetaOperation

Returns whether the operation accepts named parameters.

Specified by:

acceptsNamedParameters in interface IMetaOperation

Returns:

true if it accepts named parameters, false else

inferType

public TypeDescriptor<?> inferType()
                            throws VilException

Description copied from interface: ITemplateElement

Infers the type of this language element.

Specified by:

inferType in interface ITemplateElement

Overrides:

inferType in class TemplateBlock

Returns:

the type of this language element

Throws:

VilException - in case that type errors occur

checkEmptyContainerIntializerCompliance

private boolean checkEmptyContainerIntializerCompliance(TypeDescriptor<?> result,
                                                        TypeDescriptor<?> specifiedType)

Checks the given inferred result type and the specified result type specifiedType for type compliance against direct return of an empty container initializer.

Parameters:

result - the inferred result type

specifiedType - the specified result type

Returns:

true for compliance, false else

isFirstParameterOperand

public boolean isFirstParameterOperand()

Description copied from interface: IMetaOperation

Returns whether the first parameter is the operand.

Specified by:

isFirstParameterOperand in interface IMetaOperation

Returns:

true if the first parameter is the operand, false else

isStatic

public boolean isStatic()

Description copied from interface: IMetaOperation

Returns whether this operation is static.

Specified by:

isStatic in interface IMetaOperation

Returns:

true if it is static, false else

getDeclaringType

public IMetaType getDeclaringType()

Description copied from interface: IMetaOperation

Returns the declaring type.

Specified by:

getDeclaringType in interface IMetaOperation

Returns:

the declaring type (may be null in case of a wrapped external Java 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.

Specified by:

isPlaceholder in interface IMetaOperation

Returns:

true if this operation is a placeholder, false else

getStringValue

public java.lang.String getStringValue(IStringValueProvider.StringComparator comparator)

Description copied from interface: IStringValueProvider

Returns the string value of this object.

Specified by:

getStringValue in interface IStringValueProvider

Parameters:

comparator - if the sequence of elements, e.g., in case of collections, shall be ordered according to the comparator, null if the original sequence shall be returned

Returns:

the string value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setParent

protected void setParent(ILanguageElement parent)

Description copied from class: AbstractTemplateElement

Changes the parent. Please override if children must be adjusted according. Shall be called only once per instance, but there is no limitation.

Overrides:

setParent in class TemplateBlock

Parameters:

parent - the parent

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.

Specified by:

isCompatible in interface IMetaOperation

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.

Specified by:

invoke in interface IMetaOperation

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

isConstructor

public boolean isConstructor()

Description copied from interface: IMetaOperation

Returns whether this operation represents a constructor. Basically, for VIL a constructor is a public static method named "create" which returns an instance of the underlying type. Declared constructors are used for internal purposes.

Specified by:

isConstructor in interface IMetaOperation

Returns:

true if this operation is a "constructor", false else