Class BearerCapability

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable

    public final class BearerCapability
    extends AbstractLazyEncodedByteArray
    implements FastSerializable
    Class BearerCapability indicates a requested bearer service to be provided by the network. It represents the ASN.1 OCTET STRING type Core-INAP-CS1-DataTypes.BearerCapability.bearerCap.

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

     BearerCapability ::= CHOICE {
         iTU_T    ITU_T,
         iSO_IEC  OCTET STRING,
         national OCTET STRING,
         network  OCTET STRING
     }
    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.931 (05/98) §4.5.5 p58 and a comment in Ericsson-INAP-CS1-Datatypes.asn
    87654321
    Coding standard discriminates...
    Case ITU_TOctet 3ext. 10 0ITU_T-encoded data
    Octets 4..ITU_T-encoded data
    case ISO_IECOctet 3ext. 10 1ISO_IEC-encoded data
    Octets 4..ISO_IEC-encoded data
    case NationalOctet 3ext. 11 0National-encoded data
    Octets 4..National-encoded data
    case NetworkOctet 3ext. 11 1Network-encoded data
    Octets 4..Network-encoded data

    The Coding Standard is a discriminant for how the octets are decoded. On encoding, the discriminant is automatically set according to which alternative is encoded.
    See Also:
    Serialized Form
    • Constructor Detail

      • BearerCapability

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

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

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

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

      • isITU_TChosen

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

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

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

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

        public BearerCapability.ITU_T getITU_T()
                                        throws DecodeException
        Gets the value of the ITU_T coding standard.
        Returns:
        ITU_T representation of the ITU_T coding standard, if choice is the ITU_T coding standard, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getISO_IEC

        public byte[] getISO_IEC()
                          throws DecodeException
        Gets the value of the ISO_IEC coding standard.
        Returns:
        byte[] representation of the ISO_IEC coding standard, if choice is the ISO_IEC coding standard, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getNational

        public byte[] getNational()
                           throws DecodeException
        Gets the value of the National coding standard.
        Returns:
        byte[] representation of the National coding standard, if choice is the National coding standard, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • getNetwork

        public byte[] getNetwork()
                          throws DecodeException
        Gets the value of the Network coding standard.
        Returns:
        byte[] representation of the Network coding standard, if choice is the Network coding standard, else null
        Throws:
        DecodeException - if encoded state cannot be decoded
      • copyOf

        public static BearerCapability copyOf​(BearerCapability 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:
        BearerCapability
      • 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. 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