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

Class HourMinute

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class HourMinute
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class HourMinute represents a time HH:MM in two octets, BCD encoded.

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

     HourMinute ::= SEQUENCE {
     hour   INTEGER,
     minute INTEGER,
 }
    The class takes care of encoding the field values into a byte-array and decoding field values from a byte-array, the encoded representation being as tabulated below. The digits are encoded separately in BCD.

    Data Encoding - based on comment in ASN.1 module Core-INAP-CS1-DataTypes
    87654321
    Octet 0Hours unitsHours tens
    Octet 1Minutes unitsMinutes tens

    For example, 12:15 is encoded as 2151 (assuming the high nibble is written before the low nibble).
    See Also:
    Serialized Form

    • Constructor Detail

      • HourMinute

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

      • HourMinute

        public HourMinute​(byte[] data)
        Constructs a new HourMinute 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

      • HourMinute

        public HourMinute​(byte[] data,
                  int start,
                  int len)
        Constructs a new HourMinute 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

      • HourMinute

        public HourMinute​(int hour,
                  int minute)
        Constructs a new HourMinute object from given values for all fields.
        Parameters:
        hour - the hour, in range [0,23]
        minute - the minute, in range [0,59]

      • HourMinute

        public HourMinute​(DataInput in)
           throws IOException
        Constructs a new HourMinute 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

      • hasHour

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

      • setHourPresent

        public HourMinute setHourPresent​(boolean flag)
                          throws IllegalStateException
        Sets the presence or absence of the field Hour.
        Parameters:
        flag - whether the field should be marked as present
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • hasMinute

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

      • setMinutePresent

        public HourMinute setMinutePresent​(boolean flag)
                            throws IllegalStateException
        Sets the presence or absence of the field Minute.
        Parameters:
        flag - whether the field should be marked as present
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only

      • getHour

        public int getHour()
            throws DecodeException
        Gets the value of the hour, in range [0,23].
        Returns:
        int representation of the hour, in range [0,23]
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getMinute

        public int getMinute()
              throws DecodeException
        Gets the value of the minute, in range [0,59].
        Returns:
        int representation of the minute, in range [0,59]
        Throws:
        DecodeException - if encoded state cannot be decoded

      • copyOf

        public static HourMinute copyOf​(HourMinute 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:
        HourMinute

      • 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:
        2, or 0 if encoded value is not long enough