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

Class AddressDelimiter

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class AddressDelimiter
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class AddressDelimiter represents the startDigit, endOfReplyDigit and cancelDigit fields of CollectedInformation. These fields are one or two digits long.

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

     AddressDelimiter ::= SEQUENCE {
     delimiter DigitString
 }
    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 and S5MPP spec
    87654321
    Octet 00000Delimiter digit 1
    Octet 1*0000Delimiter digit 2

    Octet 1* is present only if there is a 2nd digit. Each digit of the delimiter field is encoded into a semi-octet, using only the least significant semi-octets. 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

      • AddressDelimiter

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

      • AddressDelimiter

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

      • AddressDelimiter

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

      • AddressDelimiter

        public AddressDelimiter​(String delimiter)
        Constructs a new AddressDelimiter object from given values for all fields.
        Parameters:
        delimiter - the digits

      • AddressDelimiter

        public AddressDelimiter​(String delimiter,
                        StringCodec<AddressDelimiter> Delimiter_codec)
        Constructs a new AddressDelimiter object from given arguments, using the given codecs for encoding fields of type String.
        Parameters:
        delimiter - the digits
        Delimiter_codec - StringCodec for delimiter

      • AddressDelimiter

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

      • hasDelimiter

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

      • getDelimiter

        public String getDelimiter​(StringCodec<AddressDelimiter> codec)
                    throws DecodeException
        Gets the value of the digits using the given codec. If the field Delimiter is not set, returns null. If the given codec is null, then uses the standard codec for this field.
        Parameters:
        codec - StringCodec to use for decoding
        Returns:
        String representation of the digits
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getDelimiterEncoded

        public byte[] getDelimiterEncoded()
        Gets a clone of the encoded value of the digits.
        Returns:
        byte[] representation of the digits

      • setDelimiterEncoded

        public AddressDelimiter setDelimiterEncoded​(byte[] encoded)
        Sets the encoded value of the digits to a clone of the given byte array.
        Parameters:
        encoded - byte[] representation of the digits
        Returns:
        this

      • copyOf

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

      • 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

      • getDelimiterCodec

        public StringCodec<AddressDelimiter> getDelimiterCodec()
        Gets the codec used for field Delimiter.
        Returns:
        StringCodec

      • 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. If the encoded value ends with a filling field, then the given len is returned. If the encoded value is so currupt that its length cannot be determined, then 0 is returned.
        Parameters:
        data - network-encoded data
        start - index into data where value commences
        len - length in data to be considered
        Returns:
        length of encoded value, or 0 if not decodable
        Throws:
        NullPointerException - if data is null