Type (Protoframework API)

java.lang.Object
- org.da.protoframework.model.types.Type

All Implemented Interfaces:

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

Direct Known Subclasses:

AliasType, ArrayType, MapType, ObjectType, SimpleType, StructType, SwitchType, UnionType
```
public abstract class Type
extends java.lang.Object
implements NamespaceElement, org.da.protoframework.model.def.DescriptedElement
```
The Type class.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`ANY` The base built-in Any type.
`static short`	`BOOL` The base built-in boolean type.
`static short`	`BYTE` The base built-in byte type.
`static short`	`CHAR` The base built-in char type.
`static short`	`DOUBLE` The base built-in double type.
`static short`	`FLOAT` The base built-in float type.
`static short`	`INT` The base built-in int type.
`static short`	`LONG` The base built-in long type.
`static short`	`NIL` The base built-in Nil type.
`static short`	`SHORT` The base built-in short type.
`static short`	`STRING` The base built-in String type.
`static short`	`UNDEF` Represents an undefined type.
`static short`	`URL` The base built-in URL type.
`static short`	`XML` The base built-in xml type.

Constructor Summary

Constructors
Constructor and Description

Type()
Empty Constructor.

Type(NamespaceKey key)
Constructor.

Type(java.lang.String name)
Constructor.

Constructors
Constructor and Description
`Type()` Empty Constructor.
`Type(NamespaceKey key)` Constructor.
`Type(java.lang.String name)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`areEqual(java.lang.Object value1, java.lang.Object value2)` Return true if two values are considered as equal for this type.
`java.lang.Object`	`copyValue(java.lang.Object value)` Copy the current value and return it.
`Data<?>`	`createData()` Create a Data for this type.
`abstract java.lang.Object`	`getDefaultValue()` Return the type default value.
`java.lang.Object`	`getDefaultValue(java.lang.String appliName)` Return the type default value.
`java.lang.String`	`getDescription()` Return the type description (may be null).
`Type`	`getExtendedType()` Return the type that this type extends.
`abstract java.lang.Object`	`getInstanceFromValue(java.lang.Object value, java.lang.Class<?> clazz)` Return a value as an instance of a class.
`NamespaceKey`	`getKey()` Return the Service key.
`java.lang.String`	`getName()` Return the type name.
`java.net.URI`	`getNamespace()` Return the type namespace
`java.lang.String`	`getNamespaceAsString()` Return the element namespace as a String.
`java.lang.Object`	`getNonEmptyDefaultValue()` Return a non empty type default value.
`Type`	`getTerminalType()` Return the terminal non alias type which is referred to by this type.
`short`	`getUnit()` Return the value unit.
`boolean`	`getValueAsBoolean(java.lang.Object value)` Return a value as a boolean.
`byte`	`getValueAsByte(java.lang.Object value)` Return a value as a byte.
`char`	`getValueAsChar(java.lang.Object value)` Return a value as a char.
`Data<?>`	`getValueAsData(java.lang.Object value)` Return a value as a Data.
`double`	`getValueAsDouble(java.lang.Object value)` Return a value as a double.
`double`	`getValueAsDouble(java.lang.Object value, short unit)` Return a value as a double, in a specified unit.
`float`	`getValueAsFloat(java.lang.Object value)` Return a value as a float.
`float`	`getValueAsFloat(java.lang.Object value, short unit)` Return a value as a float, in a specified unit.
`int`	`getValueAsInt(java.lang.Object value)` Return a value as an int.
`int`	`getValueAsInt(java.lang.Object value, short unit)` Return a value as an int.
`long`	`getValueAsLong(java.lang.Object value)` Return a value as a long.
`long`	`getValueAsLong(java.lang.Object value, short unit)` Return a value as a long.
`short`	`getValueAsShort(java.lang.Object value)` Return a value as a short.
`abstract java.lang.String`	`getValueAsString(java.lang.Object value)` Return a value as a String.
`abstract java.lang.Object`	`getValueFromInstance(java.lang.Object instance)` Return a value as an instance object.
`boolean`	`isAbstract()` Return true if the type is abstract.
`abstract boolean`	`isSupportingValue(java.lang.Object value)` Return true if the type support a specified value.
`void`	`setDescription(java.lang.String desc)` Set the type description.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, 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

- Field Detail
  - UNDEF
```
public static final short UNDEF
```
    Represents an undefined type.
    
    See Also:
    
    Constant Field Values
  - BOOL
```
public static final short BOOL
```
    The base built-in boolean type.
    
    See Also:
    
    Constant Field Values
  - CHAR
```
public static final short CHAR
```
    The base built-in char type.
    
    See Also:
    
    Constant Field Values
  - BYTE
```
public static final short BYTE
```
    The base built-in byte type.
    
    See Also:
    
    Constant Field Values
  - SHORT
```
public static final short SHORT
```
    The base built-in short type.
    
    See Also:
    
    Constant Field Values
  - INT
```
public static final short INT
```
    The base built-in int type.
    
    See Also:
    
    Constant Field Values
  - LONG
```
public static final short LONG
```
    The base built-in long type.
    
    See Also:
    
    Constant Field Values
  - FLOAT
```
public static final short FLOAT
```
    The base built-in float type.
    
    See Also:
    
    Constant Field Values
  - DOUBLE
```
public static final short DOUBLE
```
    The base built-in double type.
    
    See Also:
    
    Constant Field Values
  - STRING
```
public static final short STRING
```
    The base built-in String type.
    
    See Also:
    
    Constant Field Values
  - XML
```
public static final short XML
```
    The base built-in xml type.
    
    See Also:
    
    Constant Field Values
  - URL
```
public static final short URL
```
    The base built-in URL type.
    
    See Also:
    
    Constant Field Values
  - NIL
```
public static final short NIL
```
    The base built-in Nil type.
    
    See Also:
    
    Constant Field Values
  - ANY
```
public static final short ANY
```
    The base built-in Any type.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Type
```
public Type()
```
    Empty Constructor.
  - Type
```
public Type(NamespaceKey key)
```
    Constructor.
    
    Parameters:
    
    key - the type key
  - Type
```
public Type(java.lang.String name)
```
    Constructor.
    
    Parameters:
    
    name - the type name
- Method Detail
  - setDescription
```
public void setDescription(java.lang.String desc)
```
    Set the type description.
    
    Specified by:
    
    setDescription in interface org.da.protoframework.model.def.DescriptedElement
    
    Parameters:
    
    desc - the type description
  - getDescription
```
public java.lang.String getDescription()
```
    Return the type description (may be null).
    
    Specified by:
    
    getDescription in interface org.da.protoframework.model.def.DescriptedElement
    
    Returns:
    
    the type description
  - getName
```
public java.lang.String getName()
```
    Return the type name.
    
    Returns:
    
    the type name
  - getNamespace
```
public java.net.URI getNamespace()
```
    Return the type namespace
    
    Specified by:
    
    getNamespace in interface NamespaceElement
    
    Returns:
    
    the type namespace
  - isAbstract
```
public boolean isAbstract()
```
    Return true if the type is abstract. Return false by default.
    
    Returns:
    
    true if the type is abstract
  - getExtendedType
```
public Type getExtendedType()
```
    Return the type that this type extends. Return null by default.
    
    Returns:
    
    the type
  - getNamespaceAsString
```
public java.lang.String getNamespaceAsString()
```
    Return the element namespace as a String.
    
    Specified by:
    
    getNamespaceAsString in interface NamespaceElement
    
    Returns:
    
    the element namespace as a String
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getKey
```
public NamespaceKey getKey()
```
    Return the Service key.
    
    Specified by:
    
    getKey in interface NamespaceElement
    
    Returns:
    
    the Service key
  - getDefaultValue
```
public abstract java.lang.Object getDefaultValue()
```
    Return the type default value.
    
    Returns:
    
    the type default value
  - isSupportingValue
```
public abstract boolean isSupportingValue(java.lang.Object value)
```
    Return true if the type support a specified value.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    true if the type support a specified value
  - copyValue
```
public java.lang.Object copyValue(java.lang.Object value)
```
    Copy the current value and return it.
    
    Parameters:
    
    value - the value to copy
    
    Returns:
    
    the copied value
  - createData
```
public Data<?> createData()
```
    Create a Data for this type.
    
    Returns:
    
    the Data
  - getNonEmptyDefaultValue
```
public java.lang.Object getNonEmptyDefaultValue()
```
    Return a non empty type default value. Defer by default to getDefaultValue().
    
    Returns:
    
    a non empty type default value
  - areEqual
```
public abstract boolean areEqual(java.lang.Object value1,
                                 java.lang.Object value2)
```
    Return true if two values are considered as equal for this type.
    
    Parameters:
    
    value1 - the first value
    
    value2 - the second value
    
    Returns:
    
    true if the two values are conbsidered equal
  - getDefaultValue
```
public java.lang.Object getDefaultValue(java.lang.String appliName)
```
    Return the type default value.
    
    Parameters:
    
    appliName - the application name
    
    Returns:
    
    the type default value
  - getValueFromInstance
```
public abstract java.lang.Object getValueFromInstance(java.lang.Object instance)
```
    Return a value as an instance object.
    
    Parameters:
    
    instance - the instance object
    
    Returns:
    
    the value
  - getInstanceFromValue
```
public abstract java.lang.Object getInstanceFromValue(java.lang.Object value,
                                                      java.lang.Class<?> clazz)
```
    Return a value as an instance of a class.
    
    Parameters:
    
    value - the value
    
    clazz - the class
    
    Returns:
    
    the value as an instance of the specified class
  - getValueAsString
```
public abstract java.lang.String getValueAsString(java.lang.Object value)
```
    Return a value as a String.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a String
  - getValueAsData
```
public Data<?> getValueAsData(java.lang.Object value)
```
    Return a value as a Data.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a byte
  - getValueAsInt
```
public int getValueAsInt(java.lang.Object value)
```
    Return a value as an int.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as an int
  - getValueAsInt
```
public int getValueAsInt(java.lang.Object value,
                         short unit)
```
    Return a value as an int.
    
    Parameters:
    
    value - the value
    
    unit - the unit
    
    Returns:
    
    the value as a long
  - getValueAsShort
```
public short getValueAsShort(java.lang.Object value)
```
    Return a value as a short.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a short
  - getValueAsByte
```
public byte getValueAsByte(java.lang.Object value)
```
    Return a value as a byte.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a byte
  - getValueAsLong
```
public long getValueAsLong(java.lang.Object value)
```
    Return a value as a long.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a long
  - getValueAsLong
```
public long getValueAsLong(java.lang.Object value,
                           short unit)
```
    Return a value as a long.
    
    Parameters:
    
    value - the value
    
    unit - the unit
    
    Returns:
    
    the value as a long
  - getValueAsChar
```
public char getValueAsChar(java.lang.Object value)
```
    Return a value as a char.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a char
  - getValueAsBoolean
```
public boolean getValueAsBoolean(java.lang.Object value)
```
    Return a value as a boolean.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a boolean
  - getValueAsFloat
```
public float getValueAsFloat(java.lang.Object value)
```
    Return a value as a float.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a float
  - getValueAsFloat
```
public float getValueAsFloat(java.lang.Object value,
                             short unit)
```
    Return a value as a float, in a specified unit. Tye default implementation simply defer to getValueAsFloat(java.lang.Object).
    
    Parameters:
    
    value - the value
    
    unit - the unit
    
    Returns:
    
    the value as a float
  - getValueAsDouble
```
public double getValueAsDouble(java.lang.Object value)
```
    Return a value as a double.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value as a double
  - getValueAsDouble
```
public double getValueAsDouble(java.lang.Object value,
                               short unit)
```
    Return a value as a double, in a specified unit. Tye default implementation simply defer to getValueAsDouble(java.lang.Object).
    
    Parameters:
    
    value - the value
    
    unit - the unit
    
    Returns:
    
    the value as a double
  - getUnit
```
public short getUnit()
```
    Return the value unit.
    
    Returns:
    
    the value Unit
  - getTerminalType
```
public Type getTerminalType()
```
    Return the terminal non alias type which is referred to by this type. Return this type by default.
    
    Returns:
    
    the type

Class Type

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

UNDEF

BOOL

CHAR

BYTE

SHORT

INT

LONG

FLOAT

DOUBLE

STRING

XML

URL

NIL

ANY

Constructor Detail

Type

Type

Type

Method Detail

setDescription

getDescription

getName

getNamespace

isAbstract

getExtendedType

getNamespaceAsString

toString

getKey

getDefaultValue

isSupportingValue

copyValue

createData

getNonEmptyDefaultValue

areEqual

getDefaultValue

getValueFromInstance

getInstanceFromValue

getValueAsString

getValueAsData

getValueAsInt

getValueAsInt

getValueAsShort

getValueAsByte

getValueAsLong

getValueAsLong

getValueAsChar

getValueAsBoolean

getValueAsFloat

getValueAsFloat

getValueAsDouble

getValueAsDouble

getUnit

getTerminalType