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

Class AddressString

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class AddressString
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class AddressString encapsulates a number for addressing purposes. It represents the ASN.1 OCTET STRING type MAP-CommonDataTypes.AddressString.

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

     AddressString ::= SEQUENCE {
     sMSAddress    NULL OPTIONAL,
     nature        Nature OPTIONAL,
     sMSNature     sMSNature OPTIONAL,
     numberingPlan NumberingPlan,
     address       DigitString
 }
    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) p419 and 3GPP TS 23.040 V9.0.0 (2009-06) §9.1.2.5 p48
    87654321
    Octet 0ext. 1Nature of addressNumbering plan
    Octet 1Address digit 2Address digit 1
    .........
    Octet nFiller (1111) or Address digit 2nAddress digit 2n-1

    The length of the data encoding depends on the length of the address.

    Field sMSAddress, when present, indicates that an alphanumeric encoding of address is permitted: it determines whether nature or sMSNature is in the encoded form - either one or the other - it doesn't prevent values being set for the other, and both fields participate in the Map returned by getFieldsMap(), hence equals(), hashCode() and toString() are affected by both.

    If sMSAddress is present and sMSNature is ALPHANUMERIC, then address is encoded using the GSM7PACKED codec. Otherwise, unless overridden by a particular StringCodec, each digit of the address 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. The filler is 0xF and the encoding to semi-octets is as tabulated below.

    Decoded character0123456789*#abc
    Encoded hexadecimal0123456789ABCDEF
    See Also:
    Serialized Form

    • Constructor Detail

      • AddressString

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

      • AddressString

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

      • AddressString

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

      • AddressString

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

      • AddressString

        public AddressString​(AddressString.Nature nature,
                     AddressString.NumberingPlan numberingPlan,
                     String address)
        Constructs a new AddressString object from given values for all fields.
        Parameters:
        nature - the nature of address
        numberingPlan - the numbering plan
        address - the number digits

      • AddressString

        public AddressString​(AddressString.Nature nature,
                     AddressString.NumberingPlan numberingPlan,
                     String address,
                     StringCodec<AddressString> Address_codec)
        Constructs a new AddressString object from given arguments, using the given codecs for encoding fields of type String.
        Parameters:
        nature - the nature of address
        numberingPlan - the numbering plan
        address - the number digits
        Address_codec - StringCodec for address

    • Method Detail

      • hasSMSAddress

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

      • setSMSAddressPresent

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

      • hasNature

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

      • hasSMSNature

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

      • hasNumberingPlan

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

      • hasAddress

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

      • getAddress

        public String getAddress​(StringCodec<AddressString> codec)
                  throws DecodeException
        Gets the value of the number digits using the given codec. If the field Address is not set, returns null. If the given codec is null, then uses the standard codec for this field. The standard codec is determined by the values of other fields, so beware that changes to those other fields can affect the decoding done by this getter.
        Parameters:
        codec - StringCodec to use for decoding
        Returns:
        String representation of the number digits
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getAddressEncoded

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

      • setAddress

        public AddressString setAddress​(String value,
                                StringCodec<AddressString> codec)
                         throws IllegalArgumentException
        Sets the value of the number digits using the given codec. If the given codec is null, uses the standard codec. The standard codec is determined by the values of other fields, so ensure that those other fields are set before calling this setter.
        Parameters:
        value - String representation of the number digits
        codec - StringCodec to use for encoding
        Returns:
        this
        Throws:
        IllegalArgumentException

      • setAddressEncoded

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

      • copyOf

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

      • 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 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

      • newInstanceSMSAddress

        public static AddressString newInstanceSMSAddress()
        Factory method that creates an instance for representing an SMS address.
        Returns:
        AddressString

      • decodeSMSAddress

        public static AddressString decodeSMSAddress​(byte[] message,
                                             int start,
                                             int len)
        Constructs a new AddressString for an SMS address from the given data. Decoding is deferred until needed.
        Parameters:
        message - a bytearray containing the encoded data
        start - the offset within 'message' to begin decoding
        len - the number of valid bytes after 'offset' to decode (must be at least 1)
        Returns:
        AddressString
        Throws:
        NullPointerException - if message is null
        ArrayIndexOutOfBoundsException - if start or len are out of range

      • decodeSMSAddress

        public static AddressString decodeSMSAddress​(byte[] message)
        Constructs a new AddressString for an SMS adress from the given data. Equivalent to decodeSMSAddress(message, 0, message.length)
        Parameters:
        message - a bytearray containing the encoded data
        Returns:
        AddressString
        Throws:
        NullPointerException - if message is null

      • encodeSMSAddress

        public static byte[] encodeSMSAddress​(AddressString addressString)
                               throws EncodeException
        Encodes the given AddressString for an SMS address.
        Parameters:
        addressString - the pdu to encode
        Returns:
        the encoded form of AddressString
        Throws:
        EncodeException - if AddressString is not an SMS address

      • getAddressCodec

        public StringCodec<AddressString> getAddressCodec()
        Gets the codec used for field Address. This is the GSM7 codec if this is an SMS address with ALPHANUMERIC nature, otherwise the BCD codec.
        Returns:
        StringCodec

      • toSccpAddress

        public SccpAddress toSccpAddress​(SccpAddress.Type sccpAddressType)
        Obtain an SCCP address from this ISDN address. The SCCP address has a global title address equal to the address digits of this ISDN address (decoded using the standard digit codec) and the nature of address and numbering plan indicators are set accordingly. The translation type is set to 0.
        Parameters:
        sccpAddressType - the type of SCCP address to return. Shall not be A7.
        Returns:
        an SCCP address.

      • toSccpAddress

        public SccpAddress toSccpAddress​(SccpAddress.Type sccpAddressType,
                                 StringCodec<AddressString> codec)
        Obtain an SCCP address from this ISDN address. The SCCP address has a global title address equal to the address digits of this ISDN address (decoded using the specified codec) and the nature of address and numbering plan indicators are set accordingly. The translation type is set to 0.
        Parameters:
        sccpAddressType - the type of SCCP address to return.
        codec - the string codec to use.
        Returns:
        an SCCP address.