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

Class CalledPartyBCDNumber

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public final class CalledPartyBCDNumber
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class CalledPartyBCDNumber identifies the called party. It represents the ASN.1 OCTET STRING type CAP-datatypes.CalledPartyBCDNumber.

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

     CalledPartyBCDNumber ::= SEQUENCE {
     sMSAddress    NULL OPTIONAL,
     numberType    NumberType OPTIONAL,
     sMSNumberType SMSNumberType 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 3GPP TS 24.008 V4.17.0 (2007-09) §10.5.4.7 p363 and 3GPP TS 23.040 V9.0.0 (2009-06) §9.1.2.5 p48
    87654321
    Octet 31 extType of numberNumbering plan identification
    Octet 3+1Address digit 2Address digit 1
    .........
    Octet 3+nFiller (1111) or Address digit 2nAddress digit 2n-1

    The length of the data encoding depends on the length of the address. The octet numbering in the above table is based on that used in the cited standard for the octets encoded here, tweaked to ease specification of the address encoding.

    Field sMSAddress, when present, indicates that an alphanumeric encoding of address is permitted: it determines whether numberType or sMSNumberType 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 sMSNumberType 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

      • CalledPartyBCDNumber

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

      • CalledPartyBCDNumber

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

      • CalledPartyBCDNumber

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

      • CalledPartyBCDNumber

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

      • CalledPartyBCDNumber

        public CalledPartyBCDNumber​(CalledPartyBCDNumber.NumberType numberType,
                            CalledPartyBCDNumber.NumberingPlan numberingPlan,
                            String address)
        Constructs a new CalledPartyBCDNumber object from given values for all fields.
        Parameters:
        numberType - the type of number
        numberingPlan - the numbering plan identification
        address - the number digits

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

      • hasNumberType

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

      • hasSMSNumberType

        public boolean hasSMSNumberType()
                         throws DecodeException
        Tests whether the field SMSNumberType 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<CalledPartyBCDNumber> 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 CalledPartyBCDNumber setAddress​(String value,
                                       StringCodec<CalledPartyBCDNumber> 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 CalledPartyBCDNumber 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 CalledPartyBCDNumber copyOf​(CalledPartyBCDNumber 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:
        CalledPartyBCDNumber

      • 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 CalledPartyBCDNumber newInstanceSMSAddress()
        Factory method that creates an instance for representing an SMS address.
        Returns:
        CalledPartyBCDNumber

      • decodeSMSAddress

        public static CalledPartyBCDNumber decodeSMSAddress​(byte[] message,
                                                    int start,
                                                    int len)
        Constructs a new CalledPartyBCDNumber 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:
        CalledPartyBCDNumber
        Throws:
        NullPointerException - if message is null
        ArrayIndexOutOfBoundsException - if start or len are out of range

      • decodeSMSAddress

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

      • encodeSMSAddress

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

      • getAddressCodec

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