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

Class GenericNumber

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    Direct Known Subclasses:
    GenericNumberWithB
    public class GenericNumber
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class GenericNumber represents an address with various indicators. It represents some uses of the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.Digits (others being represented by GenericDigits).

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

     GenericNumber ::= SEQUENCE {
     numberQualifier  NumberQualifier,
     nature           Nature,
     numberIncomplete BOOLEAN,
     numberingPlan    NumberingPlan,
     presentation     Presentation,
     screening        Screening,
     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 ITU-T Q.763 (12/1999) §3.26 p35
    87654321
    Octet 1Number qualifier
    Octet 2Odd?Nature of address
    Octet 3Number incomplete?Numbering planAddress presentation restrictedScreening
    Octet 3+1Address digit 2Address digit 1
    .........
    Octet 3+nFiller (0000) 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, tweaked to ease specification of the address encoding. Field names ending in ? are booleans: 1 for true, 0 for false.

    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 0 and the encoding to semi-octets is as tabulated below.

    Decoded character0123456789
    Encoded hexadecimal0123456789ABCDEF

    Number Qualifier is irrelevant in INAP as the ASN.1 tags are sufficient to identify the parameter. However the ISUP format does not allow the exclusion of this subfield, therefore the value is network operator specific.

    See Also:
    Serialized Form

    • Constructor Detail

      • GenericNumber

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

      • GenericNumber

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

      • GenericNumber

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

      • GenericNumber

        public GenericNumber​(GenericNumber.NumberQualifier numberQualifier,
                     GenericNumber.Nature nature,
                     boolean numberIncomplete,
                     GenericNumber.NumberingPlan numberingPlan,
                     GenericNumber.Presentation presentation,
                     GenericNumber.Screening screening,
                     String address)
        Constructs a new GenericNumber object from given values for all fields.
        Parameters:
        numberQualifier - the number qualifier indicator
        nature - the nature of address indicator
        numberIncomplete - the number incomplete indicator
        numberingPlan - the numbering plan indicator
        presentation - the address presentation restricted indicator
        screening - the screening indicator
        address - the number digits

      • GenericNumber

        public GenericNumber​(GenericNumber.NumberQualifier numberQualifier,
                     GenericNumber.Nature nature,
                     boolean numberIncomplete,
                     GenericNumber.NumberingPlan numberingPlan,
                     GenericNumber.Presentation presentation,
                     GenericNumber.Screening screening,
                     String address,
                     StringCodec<GenericNumber> Address_codec)
        Constructs a new GenericNumber object from given arguments, using the given codecs for encoding fields of type String.
        Parameters:
        numberQualifier - the number qualifier indicator
        nature - the nature of address indicator
        numberIncomplete - the number incomplete indicator
        numberingPlan - the numbering plan indicator
        presentation - the address presentation restricted indicator
        screening - the screening indicator
        address - the number digits
        Address_codec - StringCodec for address

      • GenericNumber

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

      • hasNumberQualifier

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

      • 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

      • hasNumberIncomplete

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

      • setNumberIncompletePresent

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

      • 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

      • hasPresentation

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

      • hasScreening

        public boolean hasScreening()
                     throws DecodeException
        Tests whether the field Screening 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 GenericNumber.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

      • getNumberIncomplete

        public boolean getNumberIncomplete()
                            throws DecodeException
        Gets the value of the number incomplete indicator.
        Returns:
        boolean representation of the number incomplete indicator
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getPresentation

        public GenericNumber.Presentation getPresentation()
                                           throws DecodeException
        Gets the value of the address presentation restricted indicator.
        Returns:
        Presentation representation of the address presentation restricted indicator
        Throws:
        DecodeException - if encoded state cannot be decoded

      • setNumberIncomplete

        public GenericNumber setNumberIncomplete​(boolean value)
                                  throws IllegalStateException
        Sets the value of the number incomplete indicator.
        Parameters:
        value - boolean representation of the number incomplete indicator
        Returns:
        this
        Throws:
        IllegalStateException

      • getAddress

        public String getAddress​(StringCodec<GenericNumber> 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.
        Parameters:
        codec - StringCodec to use for decoding
        Returns:
        String representation of the number digits
        Throws:
        DecodeException - if encoded state cannot be decoded

      • getAddressEncoded

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

      • setAddressEncoded

        public GenericNumber setAddressEncoded​(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 GenericNumber copyOf​(GenericNumber 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:
        GenericNumber

      • 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

      • getAddressCodec

        public StringCodec<GenericNumber> getAddressCodec()
        Gets the codec used for field Address.
        Returns:
        StringCodec

      • encode

        protected void encode()
               throws EncodeException
        Computes the encoded form from the decoded form.
        Specified by:
        encode in class AbstractLazyEncodedDataObject<byte[]>
        Throws:
        EncodeException - if Nature is not in range [0,127], or Presentation is ADDRESS_NOT_AVAILABLE and any of Address is not empty or Nature is not 0 or NumberIncomplete is true or NumberingPlan is not 0 or Screening is not NETWORK_PROVIDED