Class ISDNSubaddress

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable

    public final class ISDNSubaddress
    extends AbstractLazyEncodedByteArray
    implements FastSerializable
    Class ISDNSubaddress encapsulates an ISDN subaddress. It represents the ASN.1 OCTET STRING type MAP-CommonDataTypes.ISDN-SubaddressString.

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

     ISDNSubaddress ::= CHOICE {
         nsap NSAPAddress,
         user DigitOrCharString
     }
    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.

    Data Encoding - based on comment in ASN.1 module MAP-CommonDataTypes in 3GPP TS 29.002 V10.0.0 (2010-09) p420
    87654321
    1 octet1 (ext)Nature of address discriminates...Odd?000
    ≤20 octetscase 0 (NSAP)Network Service Access Point (NSAP) address
    case 2 (USER_SPECIFIED)User-specified address

    Field names ending in ? are booleans: 1 for true, 0 for false. The value of Nature of address is 000 for choice nsap and 010 for choice user. The value of Odd? is set only for the choice user and only if that's encoding uses BCD.

    If the user field is encoded using BCD, then each digit of the user field is encoded into a semi-octet, and if there is an odd number of digits then the last semi-octet is assigned a filler. Unless overridden by a particular StringCodec, the filler is 0 and the encoding to semi-octets is as tabulated below.

    Decoded character0123456789
    Encoded hexadecimal0123456789ABCDEF
    See Also:
    Serialized Form
    • Constructor Detail

      • ISDNSubaddress

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

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

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

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

      • isNsapChosen

        public boolean isNsapChosen()
                             throws DecodeException
        Tests whether the choice is nsap.
        Returns:
        true if chosen, false if not
        Throws:
        DecodeException - if encoded state cannot be decoded
      • isUserChosen

        public boolean isUserChosen()
                             throws DecodeException
        Tests whether the choice is user.
        Returns:
        true if chosen, false if not
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getNsap

        public NSAPAddress getNsap()
                            throws DecodeException
        Gets the value of the number digits.
        Returns:
        NSAPAddress representation of the number digits, if choice is the number digits, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getUser

        public String getUser()
                       throws DecodeException
        Gets the value of the number digits. Equivalent to getUser(null).
        Returns:
        String representation of the number digits, if choice is the number digits, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getUser

        public String getUser​(StringCodec<ISDNSubaddress> codec)
                       throws DecodeException
        Gets the value of the number digits using the given codec. If the field User 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 number digits
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getUserEncoded

        public EncodedStringWithIndicators getUserEncoded()
        Gets a clone of the encoded value of the number digits.
        Returns:
        EncodedStringWithIndicators representation of the number digits, if choice is the number digits, else null
      • setUserEncoded

        public ISDNSubaddress setUserEncoded​(EncodedStringWithIndicators encoded)
        Sets the encoded value of the number digits to a clone of the given EncodedStringIndicators.
        Parameters:
        encoded - EncodedStringWithIndicators representation of the number digits
        Returns:
        this
      • copyOf

        public static ISDNSubaddress copyOf​(ISDNSubaddress 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:
        ISDNSubaddress
      • 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 :discriminant-name to field-value. If choice is not set, returns a Map from : to AbstractFieldsObject.FIELD_UNINITIALISED. For a field of primitive type, the field-value is boxed. 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 - the value of this parameter is ignored
        Returns:
        Map from :discriminant-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 variable length, so the given 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:
        len, or 0 if encoded value is not long enough