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

Class CompoundTypeDescriptor

java.lang.Object

net.ssehub.easy.instantiation.core.model.vilTypes.TypeDescriptor<CompoundInstance>

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

All Implemented Interfaces:

IMetaType

public class CompoundTypeDescriptor
extends TypeDescriptor<CompoundInstance>

Implements a compound type descriptor.

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	CompoundTypeDescriptor.ConstructorOperationDescriptor	The constructor operation(s).
static class	CompoundTypeDescriptor.SlotDescriptor	A slot field descriptor for compounds.
private static class	CompoundTypeDescriptor.TypeOperationDescriptor	Represents a type->name operation descriptor.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isAbstract
private CompoundTypeDescriptor	refines
private TypeRegistry	registry

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
CompoundTypeDescriptor(java.lang.String name, boolean isAbstract, CompoundTypeDescriptor refines, TypeRegistry registry)	Creates a compound type descriptor.

Method Summary

Modifier and Type	Method	Description
OperationDescriptor	addPlaceholderOperation(java.lang.String name, int parameterCount, boolean acceptsNamedParameters)	Adds a placeholder operation, i.e., in case that the original operation cannot be resolved but the script shall remain executable.
boolean	canBeInstantiated()	Returns whether TypeDescriptor.create(Object...) will return an instance.
boolean	checkConversion(IMetaType param, IMetaOperation conversion)	Checks a conversion from this type to param via the given conversion.
CompoundInstance	create(java.lang.Object... params)	Creates an instance of the type according to the given parameters.
IMetaType	getBaseType()	Returns the base type (in case of IVML derived types).
FieldDescriptor	getDeclaredField(java.lang.String name)	Returns the directly declared field with name name.
CompoundTypeDescriptor.SlotDescriptor	getDeclaredSlot(java.lang.String name)	Returns the directly declared slot with name name.
FieldDescriptor	getField(java.lang.String name)	Returns the field descriptor with the specified name.
CompoundTypeDescriptor	getRefines()	Returns the refined compound.
CompoundTypeDescriptor.SlotDescriptor	getSlot(int index)	Returns the specified slot descriptor.
CompoundTypeDescriptor.SlotDescriptor	getSlot(java.lang.String name)	Returns the slot descriptor with the specified name.
int	getSlotCount()	Returns the number of slots provided by this compound type.
IMetaType	getSuperType()	Returns the type this type is refined from.
java.lang.Class<CompoundInstance>	getTypeClass()	Returns the class of the described VIL type.
TypeRegistry	getTypeRegistry()	Returns the type registry this type was registered by.
boolean	isAbstract()	Returns whether the compound is abstract.
boolean	isActualTypeOf(IMetaType type)	Returns whether this type can act as an actual type of type.
boolean	isAssignableFrom(IMetaType type)	Returns whether this type is the same or a super class of type.
boolean	isAssignableFrom(TypeDescriptor<?> desc)	Returns whether this descriptor is the same or a super class of desc.
boolean	isBasicType()	Returns whether this instance represents a basic type.
boolean	isCollection()	Returns whether this descriptor represents a VIL collection, i.e., set, sequence or collection.
boolean	isInstance(java.lang.Object object)	Returns whether the given object is an instance of this descriptor.
boolean	isInstantiator()	Returns whether this type is an instantiator.
boolean	isInternal()	Returns whether this type is internal and shall not be visible to the user.
boolean	isIterator()	Returns whether this descriptor represents an iterator.
boolean	isMap()	Returns whether this descriptor represents a VIL map.
boolean	isPlaceholder()	Returns whether this type is valid or whether it is a placeholder type in case that the original type cannot be resolved but the script shall remain executable.
boolean	isSameType(java.lang.Object object)	Returns whether the given object of of the type of this descriptor.
boolean	isSequence()	Returns whether this descriptor represents a VIL sequence.
boolean	isSet()	Returns whether this descriptor represents a VIL set.
void	setFields(CompoundTypeDescriptor.SlotDescriptor[] slots)	Sets the fields of this descriptor, only if there have no fields been defined at all so far.

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

addOperation, allInstances, appendParameter, createArray, enableDynamicDispatch, findCollectionIteratorOperation, findConversion, findConversion, findConversionOnBoth, flatten, flattenParam, getCandidates, getCandidates, getConversion, getConversions, getConversionsCount, getConversionToSequence, getDefaultValue, getField, getFieldCount, getFields, getGenericParameter, getGenericParameterCount, getGenericParameterType, getName, getOperation, getOperations, getOperationsCount, getQualifiedName, getVilName, isFieldsNull, isInitialized, isNameSet, isSame, setConversions, setFields, setFields, setName, setOperations, toString

Methods inherited from class java.lang.Object

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

Field Detail

isAbstract

private boolean isAbstract

refines

private CompoundTypeDescriptor refines

registry

private TypeRegistry registry

Constructor Detail

CompoundTypeDescriptor

public CompoundTypeDescriptor(java.lang.String name,
                              boolean isAbstract,
                              CompoundTypeDescriptor refines,
                              TypeRegistry registry)
                       throws VilException

Creates a compound type descriptor.

Parameters:

name - the name of the type

isAbstract - if the type is abstract

refines - if there is a refined type (may be null for none)

registry - the defining type registry

Throws:

VilException - in case of creation problems

Method Detail

isAssignableFrom

public boolean isAssignableFrom(IMetaType type)

Description copied from interface: IMetaType

Returns whether this type is the same or a super class of type.

Parameters:

type - the descriptor to be tested

Returns:

true if both types are assignment compatible, false else

isBasicType

public boolean isBasicType()

Description copied from interface: IMetaType

Returns whether this instance represents a basic type.

Returns:

true if this instance represents a basic type, false else

getTypeRegistry

public TypeRegistry getTypeRegistry()

Description copied from interface: IMetaType

Returns the type registry this type was registered by.

Returns:

the type registry

isPlaceholder

public boolean isPlaceholder()

Description copied from interface: IMetaType

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

Returns:

true if this type is a placeholder, false else

isActualTypeOf

public boolean isActualTypeOf(IMetaType type)

Description copied from interface: IMetaType

Returns whether this type can act as an actual type of type.

Parameters:

type - the type to be checked

Returns:

true if this type can act as an actual type of type, false else

See Also:

IActualTypeProvider

getBaseType

public IMetaType getBaseType()

Description copied from interface: IMetaType

Returns the base type (in case of IVML derived types).

Returns:

the base type or null

getSuperType

public IMetaType getSuperType()

Description copied from interface: IMetaType

Returns the type this type is refined from.

Returns:

the super type or null if there is none

getRefines

public CompoundTypeDescriptor getRefines()

Returns the refined compound.

Returns:

the refined compound (may be null if there is none)

isInternal

public boolean isInternal()

Description copied from interface: IMetaType

Returns whether this type is internal and shall not be visible to the user.

Returns:

true if this type is internal, false else

checkConversion

public boolean checkConversion(IMetaType param,
                               IMetaOperation conversion)

Description copied from interface: IMetaType

Checks a conversion from this type to param via the given conversion.

Parameters:

param - the original parameter value

conversion - the conversion function

Returns:

true if ok, false else

getTypeClass

public java.lang.Class<CompoundInstance> getTypeClass()

Description copied from class: TypeDescriptor

Returns the class of the described VIL type. Please use this method sparingly as the required functionality is provided by this class.

Specified by:

getTypeClass in class TypeDescriptor<CompoundInstance>

Returns:

the class

canBeInstantiated

public boolean canBeInstantiated()

Description copied from class: TypeDescriptor

Returns whether TypeDescriptor.create(Object...) will return an instance.

Specified by:

canBeInstantiated in class TypeDescriptor<CompoundInstance>

Returns:

true if this type can be instantiated from VIL/VTL, false else

isAbstract

public boolean isAbstract()

Returns whether the compound is abstract.

Returns:

true for abstract, false else

create

public CompoundInstance create(java.lang.Object... params)
                        throws VilException

Description copied from class: TypeDescriptor

Creates an instance of the type according to the given parameters.

Specified by:

create in class TypeDescriptor<CompoundInstance>

Parameters:

params - the parameters

Returns:

the created instance

Throws:

VilException - in case that the creation does not work

isAssignableFrom

public boolean isAssignableFrom(TypeDescriptor<?> desc)

Description copied from class: TypeDescriptor

Returns whether this descriptor is the same or a super class of desc.

Specified by:

isAssignableFrom in class TypeDescriptor<CompoundInstance>

Parameters:

desc - the descriptor to be tested

Returns:

true if both descriptors are assignment compatible, false else

isMap

public boolean isMap()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL map.

Specified by:

isMap in class TypeDescriptor<CompoundInstance>

Returns:

true if this is a VIL map, false else

isIterator

public boolean isIterator()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents an iterator.

Specified by:

isIterator in class TypeDescriptor<CompoundInstance>

Returns:

true if this is an iterator, false else

isCollection

public boolean isCollection()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL collection, i.e., set, sequence or collection.

Specified by:

isCollection in class TypeDescriptor<CompoundInstance>

Returns:

true if this is a VIL collection, false else

isSet

public boolean isSet()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL set.

Specified by:

isSet in class TypeDescriptor<CompoundInstance>

Returns:

true if this is a VIL set, false else

isSequence

public boolean isSequence()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL sequence.

Specified by:

isSequence in class TypeDescriptor<CompoundInstance>

Returns:

true if this is a VIL sequence, false else

isInstance

public boolean isInstance(java.lang.Object object)

Description copied from class: TypeDescriptor

Returns whether the given object is an instance of this descriptor.

Specified by:

isInstance in class TypeDescriptor<CompoundInstance>

Parameters:

object - the object to be checked

Returns:

true if it is an instance, false else

isSameType

public boolean isSameType(java.lang.Object object)

Description copied from class: TypeDescriptor

Returns whether the given object of of the type of this descriptor.

Specified by:

isSameType in class TypeDescriptor<CompoundInstance>

Parameters:

object - the object to be checked

Returns:

true if object has the same type, false else

addPlaceholderOperation

public OperationDescriptor addPlaceholderOperation(java.lang.String name,
                                                   int parameterCount,
                                                   boolean acceptsNamedParameters)

Description copied from class: TypeDescriptor

Adds a placeholder operation, i.e., in case that the original operation cannot be resolved but the script shall remain executable.

Specified by:

addPlaceholderOperation in interface IMetaType

Specified by:

addPlaceholderOperation in class TypeDescriptor<CompoundInstance>

Parameters:

name - the name of the operation

parameterCount - the number of parameters of the operation

acceptsNamedParameters - whether the operation accepts named parameters

Returns:

the added operation, null if this type is not a placeholder

isInstantiator

public boolean isInstantiator()

Description copied from class: TypeDescriptor

Returns whether this type is an instantiator.

Specified by:

isInstantiator in class TypeDescriptor<CompoundInstance>

Returns:

true if it is an instantiator, false else

setFields

public void setFields(CompoundTypeDescriptor.SlotDescriptor[] slots)
               throws VilException

Sets the fields of this descriptor, only if there have no fields been defined at all so far.

Parameters:

slots - the slots defining the fields

Throws:

VilException - in case that fields have been defined already

getSlot

public CompoundTypeDescriptor.SlotDescriptor getSlot(int index)

Returns the specified slot descriptor.

Parameters:

index - the 0-based index of the field to be returned

Returns:

the specified field

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index>=getSlotCount()

getSlotCount

public int getSlotCount()

Returns the number of slots provided by this compound type.

Returns:

the number of slots

getDeclaredField

public FieldDescriptor getDeclaredField(java.lang.String name)

Returns the directly declared field with name name.

Parameters:

name - the name of the field

Returns:

the field descriptor or null

getField

public FieldDescriptor getField(java.lang.String name)

Description copied from class: TypeDescriptor

Returns the field descriptor with the specified name.

Overrides:

getField in class TypeDescriptor<CompoundInstance>

Parameters:

name - the name of the field

Returns:

the field descriptor (may be null if not found)

getSlot

public CompoundTypeDescriptor.SlotDescriptor getSlot(java.lang.String name)

Returns the slot descriptor with the specified name.

Parameters:

name - the name of the slot

Returns:

the slot descriptor (may be null if not found)

getDeclaredSlot

public CompoundTypeDescriptor.SlotDescriptor getDeclaredSlot(java.lang.String name)

Returns the directly declared slot with name name.

Parameters:

name - the name of the slot

Returns:

the slot descriptor or null