org.da.protoframework.model.types

Class UnionType

java.lang.Object

org.da.protoframework.model.types.Type

org.da.protoframework.model.types.UnionType

All Implemented Interfaces:

org.da.protoframework.model.def.DescriptedElement, NamespaceElement

public class UnionType
extends Type

Represent union types. Note that union types values are constituted by lists with two elements:

• The first element in the list being the int value of the variantType
• The second element in the list being the value of the member

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnionType.Member Represent a member.

Field Summary

Fields inherited from class org.da.protoframework.model.types.Type

ANY, BOOL, BYTE, CHAR, DOUBLE, FLOAT, INT, LONG, NIL, SHORT, STRING, UNDEF, URL, XML

Constructor Summary

Constructors

Constructor and Description
UnionType(NamespaceKey key) Constructor.
UnionType(java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addMember(UnionType.Member member) Add a Member.
boolean	areEqual(java.lang.Object value1, java.lang.Object value2) Return true if two values are considered as equal for this type.
void	clearMembers() Clear the members of the union.
java.util.List<java.lang.Object>	copyValue(java.lang.Object value) Copy the current value and return it.
int	countMembers() Return the number of members.
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.Object>	getDefaultValue() Return the type default value.
UnionType	getExtendedType() Return the type that this type extends.
java.lang.Object	getInstanceFromValue(java.lang.Object value, java.lang.Class<?> clazz) Return a value as an instance of a class.
UnionType.Member	getMember(int variant) Return the Member at a specified position.
UnionType.Member	getMember(java.lang.String name) Return the Member of a specified name.
java.util.Map<java.lang.String,UnionType.Member>	getMembers() Return the members sorted by their name.
java.util.List<UnionType.Member>	getMembersList() Return the ordered list of members.
Type	getMemberType(java.util.List<java.lang.Object> value) Return the member type.
java.lang.Object	getMemberValue(java.util.List<java.lang.Object> value) Return the member value.
int	getMemberVariant(java.util.List<java.lang.Object> value) Return the member variant.
int	getMemberVariant(java.lang.String name) Return the variantType of a specified Member.
java.util.List<java.lang.Object>	getNonEmptyDefaultValue() Return a non empty type default value.
Data.Union	getValueAsData(java.lang.Object value) Return a value as a Data.
java.lang.String	getValueAsString(java.lang.Object value) Return a value as a String.
java.lang.Object	getValueFromInstance(java.lang.Object instance) Return a value as an instance object.
SimpleType	getVariant() Return the type of the Union variantType.
static UnionType	getVoid() Return an empty Union type, which contains no members.
int	hashCode()
boolean	hasMember(java.lang.String name) Return true if the Union has a member of a specified name.
boolean	isAbstract() Return true if the type is abstract.
boolean	isSupportingValue(java.lang.Object value) Return true if the specified value is supported.
void	lockDefinition() Lock the fields definition of this type.
void	setAbstract(boolean isAbstract) Set if the type is abstract.
void	setExtendedType(UnionType type) Set the type that this type extends.
boolean	setMemberValue(int variant, java.util.List<java.lang.Object> values) Set the default value of the Union for a specified variantType.
boolean	setMemberValue(int variant, java.util.List<java.lang.Object> values, java.lang.Object value) Set the value of the Union for a specified variantType.
boolean	setMemberValue(java.lang.String name, java.util.List<java.lang.Object> values) Set the default value of the Union for a specified variantType.
boolean	setMemberValue(java.lang.String name, java.util.List<java.lang.Object> values, java.lang.Object value) Set the value of the Union for a specified variantType.
void	setVariant(SimpleType variant) Set the type of the Union variantType.

Methods inherited from class org.da.protoframework.model.types.Type

createData, getDefaultValue, getDescription, getKey, getName, getNamespace, getNamespaceAsString, getTerminalType, getUnit, getValueAsBoolean, getValueAsByte, getValueAsChar, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFloat, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, getValueAsShort, setDescription, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.da.protoframework.model.namespace.NamespaceElement

getFullName

Methods inherited from interface org.da.protoframework.model.def.DescriptedElement

hasDescription

Constructor Detail

UnionType

public UnionType(java.lang.String name)

Constructor.

Parameters:

name - the type name

UnionType

public UnionType(NamespaceKey key)

Constructor.

Parameters:

key - the type key

Method Detail

getVoid

public static UnionType getVoid()

Return an empty Union type, which contains no members.

Returns:

the empty Union type

setAbstract

public void setAbstract(boolean isAbstract)

Set if the type is abstract.

Parameters:

isAbstract - true if the type is abstract

isAbstract

public boolean isAbstract()

Return true if the type is abstract.

Overrides:

isAbstract in class Type

Returns:

true if the type is abstract

setExtendedType

public void setExtendedType(UnionType type)

Set the type that this type extends.

Parameters:

type - the type

getExtendedType

public UnionType getExtendedType()

Return the type that this type extends. If this type does not extend any other type, then the method will return null.

Overrides:

getExtendedType in class Type

Returns:

the type

setVariant

public void setVariant(SimpleType variant)

Set the type of the Union variantType.

Parameters:

variant - the type of the Union variantType

getVariant

public SimpleType getVariant()

Return the type of the Union variantType.

Returns:

the type of the Union variantType

getDefaultValue

public java.util.List<java.lang.Object> getDefaultValue()

Return the type default value.

Specified by:

getDefaultValue in class Type

Returns:

the type default value

getNonEmptyDefaultValue

public java.util.List<java.lang.Object> getNonEmptyDefaultValue()

Return a non empty type default value.

Overrides:

getNonEmptyDefaultValue in class Type

Returns:

a non empty type default value

areEqual

public boolean areEqual(java.lang.Object value1,
                        java.lang.Object value2)

Return true if two values are considered as equal for this type.

Specified by:

areEqual in class Type

Parameters:

value1 - the first value

value2 - the second value

Returns:

true if the two values are conbsidered equal

getMemberVariant

public int getMemberVariant(java.util.List<java.lang.Object> value)

Return the member variant.

Parameters:

value - the union value

Returns:

the member variant

getMemberValue

public java.lang.Object getMemberValue(java.util.List<java.lang.Object> value)

Return the member value.

Parameters:

value - the union value

Returns:

the member value

getValueFromInstance

public java.lang.Object getValueFromInstance(java.lang.Object instance)

Return a value as an instance object.

Specified by:

getValueFromInstance in class Type

Parameters:

instance - the instance object

Returns:

the value

getInstanceFromValue

public java.lang.Object getInstanceFromValue(java.lang.Object value,
                                             java.lang.Class<?> clazz)

Return a value as an instance of a class.

Specified by:

getInstanceFromValue in class Type

Parameters:

value - the value

clazz - the class

Returns:

the value as an instance of the specified class

getValueAsData

public Data.Union getValueAsData(java.lang.Object value)

Return a value as a Data.

Overrides:

getValueAsData in class Type

Parameters:

value - the value

Returns:

the value as a Data

getMemberType

public Type getMemberType(java.util.List<java.lang.Object> value)

Return the member type.

Parameters:

value - the union value

Returns:

the member type

setMemberValue

public boolean setMemberValue(java.lang.String name,
                              java.util.List<java.lang.Object> values,
                              java.lang.Object value)

Set the value of the Union for a specified variantType.

Parameters:

name - the member name

values - the values

value - the member value

Returns:

true if the variantType contains a value for the specified member name

setMemberValue

public boolean setMemberValue(java.lang.String name,
                              java.util.List<java.lang.Object> values)

Set the default value of the Union for a specified variantType.

Parameters:

name - the member name

values - the values

Returns:

true if the variantType contains a value for the specified member name

setMemberValue

public boolean setMemberValue(int variant,
                              java.util.List<java.lang.Object> values)

Set the default value of the Union for a specified variantType.

Parameters:

variant - the variantType

values - the values

Returns:

true if the variantType contains a value for the specified variantType

setMemberValue

public boolean setMemberValue(int variant,
                              java.util.List<java.lang.Object> values,
                              java.lang.Object value)

Set the value of the Union for a specified variantType.

Parameters:

variant - the variantType

values - the values

value - the member value

Returns:

true if the variantType contains a value for the specified variantType

copyValue

public java.util.List<java.lang.Object> copyValue(java.lang.Object value)

Copy the current value and return it.

Overrides:

copyValue in class Type

Parameters:

value - the value to copy

Returns:

the copied value

getValueAsString

public java.lang.String getValueAsString(java.lang.Object value)

Return a value as a String.

Specified by:

getValueAsString in class Type

Parameters:

value - the value

Returns:

the value as a String

isSupportingValue

public boolean isSupportingValue(java.lang.Object value)

Return true if the specified value is supported.

Specified by:

isSupportingValue in class Type

Parameters:

value - the value

Returns:

true if the specified value is supported

lockDefinition

public void lockDefinition()

Lock the fields definition of this type.

clearMembers

public void clearMembers()

Clear the members of the union. Note that it will no nothing for the client modules, as this is reserved for the configuration stage of the framework.

hasMember

public boolean hasMember(java.lang.String name)

Return true if the Union has a member of a specified name.

Parameters:

name - the members name

Returns:

true if the Union has a member of the specified name

countMembers

public int countMembers()

Return the number of members.

Returns:

the number of members

getMembers

public java.util.Map<java.lang.String,UnionType.Member> getMembers()

Return the members sorted by their name.

Returns:

the members

getMembersList

public java.util.List<UnionType.Member> getMembersList()

Return the ordered list of members.

Returns:

the ordered list of members

getMember

public UnionType.Member getMember(int variant)

Return the Member at a specified position.

Parameters:

variant - the variantType

Returns:

the Member

getMember

public UnionType.Member getMember(java.lang.String name)

Return the Member of a specified name.

Parameters:

name - the Member name

Returns:

the Member

getMemberVariant

public int getMemberVariant(java.lang.String name)

Return the variantType of a specified Member.

Parameters:

name - the Member name

Returns:

the Member variantType

addMember

public void addMember(UnionType.Member member)

Add a Member.

Parameters:

member - the Member

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object