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

Class SMSAddress

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class SMSAddress
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class SMSAddress encapsulates a SM-TL address field, which appears inside a SMSTPDU, hence it represents part of a larger octet string.

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

     SMSAddress ::= SEQUENCE {
     nature        Nature,
     numberingPlan NumberingPlan,
     address       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 3GPP TS 23.040 V9.0.0 (2009-06) §9.1.2.5 pp47-49
    87654321
    Octet 0Address length
    Octet 11Nature of addressNumbering plan
    Octet 2..Address value

    The length of the data encoding depends on the address value and how that is encoded according to the nature of address. The address length is always expressed in semi-octets, regardless of the nature of address.

    If the address is encoded using BCD, then 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. Unless overridden by a particular StringCodec, 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

      • SMSAddress

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

      • SMSAddress

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

      • SMSAddress

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

      • SMSAddress

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

      • SMSAddress

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

      • SMSAddress

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

      • 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

      • 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

      • getNature

        public SMSAddress.Nature getNature()
                            throws DecodeException
        Gets the value of the nature of address indicator.
        Returns:
        Nature representation of the nature of address indicator
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getNumberingPlan

        public SMSAddress.NumberingPlan getNumberingPlan()
                                          throws DecodeException
        Gets the value of the numbering plan indicator.
        Returns:
        NumberingPlan representation of the numbering plan indicator
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getAddress

        public String getAddress​(StringCodec<SMSAddress> codec)
                  throws DecodeException
        Gets the value of the address 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 address
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getAddressEncoded

        public EncodedStringWithIndicators getAddressEncoded()
        Gets a clone of the encoded value of the address.
        Returns:
        EncodedStringWithIndicators representation of the address

      • setAddress

        public SMSAddress setAddress​(String value,
                             StringCodec<SMSAddress> codec)
                      throws IllegalArgumentException
        Sets the value of the address 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 address
        codec - StringCodec to use for encoding
        Returns:
        this
        Throws:
        IllegalArgumentException

      • setAddressEncoded

        public SMSAddress setAddressEncoded​(EncodedStringWithIndicators encoded)
        Sets the encoded value of the address to a clone of the given EncodedStringIndicators.
        Parameters:
        encoded - EncodedStringWithIndicators representation of the address
        Returns:
        this

      • copyOf

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

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

      • getAddressCodec

        public StringCodec<SMSAddress> getAddressCodec()
        Gets the codec used for field Address. This depends on whether the current value of field Nature is ALPHANUMERIC or not.
        Returns:
        StringCodec, or null if Nature is uninitialised