Package com.opencloud.slee.resources.in.datatypes.cc

Class PriceInHundredthsOfUnits

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class PriceInHundredthsOfUnits
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class PriceInHundredthsOfUnits represents a currency value, with a maximum of six digits before the decimal point and two digits after.

    The API offered by this class is as if the type were specified in ASN.1 as follows. 

     PriceInHundredthsOfUnits ::= SEQUENCE {
     price INTEGER
 }
    The class takes care of encoding the field value into a byte-array and decoding the field value from a byte-array, the encoded representation being as tabulated below.

    Data Encoding - based on comment in ASN.1 module CAP-datatypes
    87654321
    Octet 0Tens of thousandsHundreds of thousands
    Octet 1HundredsThousands
    Octet 2UnitsTens
    Octet 3HundredthsTenths

    Each digit of the price field is encoded into a semi-octet. Unless overridden by a particular StringCodec, the encoding to semi-octets is as tabulated below.

    Decoded character0123456789
    Encoded hexadecimal0123456789ABCDEF
    See Also:
    Serialized Form

    • Constructor Detail

      • PriceInHundredthsOfUnits

        public PriceInHundredthsOfUnits()
        Constructs a new PriceInHundredthsOfUnits object with no fields set.

      • PriceInHundredthsOfUnits

        public PriceInHundredthsOfUnits​(byte[] data)
        Constructs a new PriceInHundredthsOfUnits object from network-encoded data. The data is not decoded and might not be decodable.
        Parameters:
        data - network-encoded data
        Throws:
        NullPointerException - if data is null

      • PriceInHundredthsOfUnits

        public PriceInHundredthsOfUnits​(byte[] data,
                                int start,
                                int len)
        Constructs a new PriceInHundredthsOfUnits object from part of network-encoded data. The part starts at index start and is len bytes long. The data is not decoded and might not be decodable.
        Parameters:
        data - network-encoded data
        start - starting offset of network-encoded data in byte array
        len - default length if not predictable
        Throws:
        NullPointerException - if data is null
        IllegalArgumentException - if len is negative

      • PriceInHundredthsOfUnits

        public PriceInHundredthsOfUnits​(int price)
        Constructs a new PriceInHundredthsOfUnits object from given values for all fields.
        Parameters:
        price - the price as integer number of hundredths

      • PriceInHundredthsOfUnits

        public PriceInHundredthsOfUnits​(DataInput in)
                         throws IOException
        Constructs a new PriceInHundredthsOfUnits object from data deserialized from a stream that was written by toStream(DataOutput).
        Parameters:
        in - the stream to read from
        Throws:
        EOFException - if reading is pre-empted by end-of-file
        IOException - if the data cannot be read

    • Method Detail

      • hasPrice

        public boolean hasPrice()
                 throws DecodeException
        Tests whether the field Price has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getPrice

        public int getPrice()
             throws DecodeException
        Gets the value of the price as integer number of hundredths.
        Returns:
        int representation of the price as integer number of hundredths
        Throws:
        DecodeException - if encoded state cannot be decoded

      • copyOf

        public static PriceInHundredthsOfUnits copyOf​(PriceInHundredthsOfUnits from)
        Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
        Parameters:
        from - the object from which to copy
        Returns:
        PriceInHundredthsOfUnits

      • getFieldAccessors

        public static FieldAccessor[] getFieldAccessors()
        Gets a new array of the accessors for fields of this type.
        Returns:
        FieldAccessor[]

      • getFieldsMap

        public Map<String,​Object> getFieldsMap​(boolean withAbsents)
        Gets a Map from field-name to field-value for the fields of a sequence. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an uninitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED. For a field of String type, the encoded form is used if the String cannot be decoded. For a type that represents an OCTET STRING that cannot be decoded, a map from "encodedValue" to the byte array value is returned.
        Specified by:
        getFieldsMap in class AbstractFieldsObject
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value

      • encodedIsInvalid

        protected boolean encodedIsInvalid()
        Determines whether the encoded form is invalid.
        Returns:
        boolean

      • getEncodedForm

        public byte[] getEncodedForm()
                      throws EncodeException
        Gets the encoded form.
        Returns:
        encoded form
        Throws:
        EncodeException - if encoding fails

      • getContainedLength

        public static int getContainedLength​(byte[] data,
                                     int start,
                                     int len)
        Determines the length of the encoded value that commences at offset start in the given data. The value is not fully decoded and might not be decodable. Values of this type are of a fixed length, so that length is returned if the data is long enough, otherwise 0 is returned.
        Parameters:
        data - network-encoded data
        start - index into data where value commences
        len - length in data to be considered
        Returns:
        4, or 0 if encoded value is not long enough

      • getPriceAsString

        public String getPriceAsString()
        Gets the value of the field Price as a String.
        Returns:
        value of the field

      • getPriceAsBigDecimal

        public BigDecimal getPriceAsBigDecimal()
        Gets the value of the field Price as a BigDecimal.
        Returns:
        value of the field

      • setPriceAsBigDecimal

        public PriceInHundredthsOfUnits setPriceAsBigDecimal​(BigDecimal value)
        Sets the value of the field Price as a BigDecimal.
        Parameters:
        value - the new value for the field in hundredths
        Returns:
        this