DataObject (jdlms 0.11.0 API)

java.lang.Object
- org.openmuc.jdlms.datatypes.DataObject

```
public class DataObject
extends java.lang.Object
```
Container class holding data about to send to the smart meter or received by the smart meter
Either stores a Number, List of DataObjects, a byte array, BitString or a subtype CosemDateFormat.
ALPDU (Application Layer Protocol Data Unit)

Method Summary

Methods
Modifier and Type	Method and Description
`org.openmuc.jdlms.internal.asn1.cosem.Data.Choices`	`choiceIndex()`
`boolean`	`isBitString()` Is used to determine if the data contains a `BitString` object.
`boolean`	`isBoolean()` Checks if the data of this container is a boolean.
`boolean`	`isByteArray()` Checks if the data of this container is a byte array.
`boolean`	`isComplex()` Checks if the data of this container is of a complex type.
`boolean`	`isCosemDateFormat()` Checks if the data of this container is a `CosemDateFormat` object.
`boolean`	`isNull()` Checks if the data of this container is `null`.
`boolean`	`isNumber()` Checks if the data of this container is a number
`static DataObject`	`newArrayData(java.util.List<DataObject> array)` Constructs a array data.
`static DataObject`	`newBcdData(byte bcd)` Constructs a 2 digit BCD number data
`static DataObject`	`newBitStringData(BitString bitString)` Constructs a bit string data.
`static DataObject`	`newBoolData(boolean bool)` Constructs a bool data.
`static DataObject`	`newDateData(CosemDate date)` Constructs a calendar datum holding a date
`static DataObject`	`newDateTimeData(CosemDateTime dateTime)` Constructs a calendar datum holding date and time
`static DataObject`	`newEnumerateData(int enumVal)` Constructs a enum data
`static DataObject`	`newFloat32Data(float float32)` Constructs a 32 bit floating point number data.
`static DataObject`	`newFloat64Data(double float64)` Constructs a 64 bit floating point number data.
`static DataObject`	`newInteger16Data(short int16)` Constructs a int 16 data
`static DataObject`	`newInteger32Data(int int32)` Constructs a int 32 data.
`static DataObject`	`newInteger64Data(long int64)` Constructs a int 64 data
`static DataObject`	`newInteger8Data(byte int8)` Constructs a int 8 data
`static DataObject`	`newNullData()` Constructs a empty datum.
`static DataObject`	`newOctetStringData(byte[] string)` Constructs a byte array data.
`static DataObject`	`newStructureData(java.util.List<DataObject> structure)` Constructs a structure data.
`static DataObject`	`newTimeData(CosemTime time)` Constructs a calendar datum holding a time
`static DataObject`	`newUInteger16Data(int uInt16)` Constructs a unsigned int 16 data
`static DataObject`	`newUInteger32Data(long uIn32)` Constructs a unsigned int 32 data.
`static DataObject`	`newUInteger64Data(long uInt64)` Constructs a unsigned int 64 data
`static DataObject`	`newUInteger8Data(short uInt8)` Constructs a unsigned int 8 data
`static DataObject`	`newVisibleStringData(byte[] string)` Constructs a string, encoded as byte array data.
`java.lang.Object`	`rawValue()` Returns the raw object-value.
`<T> T`	`value()` Returns the value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - newNullData
```
public static DataObject newNullData()
```
    Constructs a empty datum.
    
    Returns:
    The data
  - newArrayData
```
public static DataObject newArrayData(java.util.List<DataObject> array)
                               throws java.lang.IllegalArgumentException
```
    Constructs a array data.
    
    Parameters:
    array - The array of values
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException - If a sub element of array has another data type than the first
  - newStructureData
```
public static DataObject newStructureData(java.util.List<DataObject> structure)
```
    Constructs a structure data.
    
    Parameters:
    structure - The structure of values
    
    Returns:
    The data
  - newBoolData
```
public static DataObject newBoolData(boolean bool)
```
    Constructs a bool data.
    
    Parameters:
    bool - The structure of values
    
    Returns:
    The data
  - newBitStringData
```
public static DataObject newBitStringData(BitString bitString)
                                   throws java.lang.IllegalArgumentException
```
    Constructs a bit string data.
    
    Parameters:
    bitString - The BitString object holding the bit string
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException
  - newInteger32Data
```
public static DataObject newInteger32Data(int int32)
```
    Constructs a int 32 data.
    
    Parameters:
    int32 - he number to store
    
    Returns:
    The data
  - newUInteger32Data
```
public static DataObject newUInteger32Data(long uIn32)
```
    Constructs a unsigned int 32 data.
    
    Parameters:
    uIn32 - he number to store
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException - if uInt32 is > 2^(32)-1 or negative
  - newOctetStringData
```
public static DataObject newOctetStringData(byte[] string)
```
    Constructs a byte array data.
    
    Parameters:
    string - The byte array to store
    
    Returns:
    The data
  - newVisibleStringData
```
public static DataObject newVisibleStringData(byte[] string)
```
    Constructs a string, encoded as byte array data.
    
    Parameters:
    string - The byte string to store
    
    Returns:
    The data
  - newBcdData
```
public static DataObject newBcdData(byte bcd)
                             throws java.lang.IllegalArgumentException
```
    Constructs a 2 digit BCD number data
    
    Parameters:
    bcd - The BCD number to store
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException
  - newInteger8Data
```
public static DataObject newInteger8Data(byte int8)
                                  throws java.lang.IllegalArgumentException
```
    Constructs a int 8 data
    
    Parameters:
    int8 - The number to store
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException
  - newUInteger8Data
```
public static DataObject newUInteger8Data(short uInt8)
                                   throws java.lang.IllegalArgumentException
```
    Constructs a unsigned int 8 data
    
    Parameters:
    uInt8 - The number to store
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException - if uInt8 > 2^(8)-1 or negative
  - newInteger16Data
```
public static DataObject newInteger16Data(short int16)
```
    Constructs a int 16 data
    
    Parameters:
    int16 - The number to store
    
    Returns:
    The data
  - newUInteger16Data
```
public static DataObject newUInteger16Data(int uInt16)
```
    Constructs a unsigned int 16 data
    
    Parameters:
    uInt16 - The number to store
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException - If newVal > 2^(16)-1 or negative
  - newInteger64Data
```
public static DataObject newInteger64Data(long int64)
```
    Constructs a int 64 data
    
    Parameters:
    int64 - The number to store
    
    Returns:
    The data
  - newUInteger64Data
```
public static DataObject newUInteger64Data(long uInt64)
```
    Constructs a unsigned int 64 data
    
    Parameters:
    uInt64 - The number to store
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException - if uInt64 is negative
  - newEnumerateData
```
public static DataObject newEnumerateData(int enumVal)
```
    Constructs a enum data
    
    Parameters:
    enumVal - The enum value to store
    
    Returns:
    The data
    
    Throws:
    
    java.lang.IllegalArgumentException - if newVal is > 2^(8)-1 or negative
  - newFloat32Data
```
public static DataObject newFloat32Data(float float32)
```
    Constructs a 32 bit floating point number data.
    
    Parameters:
    float32 - The number to store
    
    Returns:
    The data
  - newFloat64Data
```
public static DataObject newFloat64Data(double float64)
```
    Constructs a 64 bit floating point number data.
    
    Parameters:
    float64 - The number to store
    
    Returns:
    The data
  - newDateTimeData
```
public static DataObject newDateTimeData(CosemDateTime dateTime)
```
    Constructs a calendar datum holding date and time
    
    Parameters:
    dateTime - The date and time to store
    
    Returns:
    The data
  - newDateData
```
public static DataObject newDateData(CosemDate date)
```
    Constructs a calendar datum holding a date
    
    Parameters:
    date - The date store
    
    Returns:
    The data
  - newTimeData
```
public static DataObject newTimeData(CosemTime time)
```
    Constructs a calendar datum holding a time
    
    Parameters:
    time - The time store
    
    Returns:
    The data
  - choiceIndex
```
public org.openmuc.jdlms.internal.asn1.cosem.Data.Choices choiceIndex()
```
  - value
```
public <T> T value()
        throws java.lang.ClassCastException
```
    Returns the value.
    
    Type Parameters:
    T - the type in which the raw data should be cast.
    
    Returns:
    the typed value.
    
    Throws:
    
    java.lang.ClassCastException - when the value doesn't match the assigned type.
  - rawValue
```
public java.lang.Object rawValue()
```
    Returns the raw object-value.
    
    Returns:
    the raw object-value.
  - isBitString
```
public boolean isBitString()
```
    Is used to determine if the data contains a BitString object.
    
    Returns:
    true if it contains a BitString object.
  - isNumber
```
public boolean isNumber()
```
    Checks if the data of this container is a number
    
    Returns:
    true data is a number.
  - isComplex
```
public boolean isComplex()
```
    Checks if the data of this container is of a complex type.
    A complex container holds one or more sub container of type DataObject as values.
    
    A container is of complex type if choiceIndex() returns either Data.Choices.ARRAY, Data.Choices.STRUCTURE or Data.Choices.COMPACT_ARRAY.
    
    Returns:
    true is the DataObject holds a List of DataObject.
  - isByteArray
```
public boolean isByteArray()
```
    Checks if the data of this container is a byte array.
    A container is a byte array if choiceIndex() returns either Data.Choices.OCTET_STRING, Data.Choices.VISIBLE_STRING or Data.Choices.BIT_STRING.
    
    Returns:
    true if the data is a byte array (byte[]).
  - isBoolean
```
public boolean isBoolean()
```
    Checks if the data of this container is a boolean.
    
    Returns:
    true if the data is a boolean.
  - isCosemDateFormat
```
public boolean isCosemDateFormat()
```
    Checks if the data of this container is a CosemDateFormat object.
    A container is a calendar if choiceIndex() returns either Data.Choices.DATE_TIME, Data.Choices.DATE or Data.Choices.TIME.
    
    Returns:
    true if the data is a CosemDateFormat.
  - isNull
```
public boolean isNull()
```
    Checks if the data of this container is null.
    
    Returns:
    true if the data is null.

Class DataObject

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newNullData

newArrayData

newStructureData

newBoolData

newBitStringData

newInteger32Data

newUInteger32Data

newOctetStringData

newVisibleStringData

newBcdData

newInteger8Data

newUInteger8Data

newInteger16Data

newUInteger16Data

newInteger64Data

newUInteger64Data

newEnumerateData

newFloat32Data

newFloat64Data

newDateTimeData

newDateData

newTimeData

choiceIndex

value

rawValue

isBitString

isNumber

isComplex

isByteArray

isBoolean

isCosemDateFormat

isNull