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

Class MSBearerCapability

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    public class MSBearerCapability
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class MSBearerCapability indicates a requested bearer service to be provided by the mobile network. It represents the ASN.1 OCTET STRING type S5-CommonDataTypes.BearerCapability.gsmBearCap.

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

     MSBearerCapability ::= CHOICE {
     gSM   GSM,
     other 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 3GPP TS 24.008 v4.17.0 (2007-09) §10.5.4.5 pp343-361
    87654321
    Coding standard discriminates...
    Case GSMOctet 3GSM-encoded data0GSM-encoded data
    Octets...GSM-encoded data
    Case OTHEROctet 3OTHER-encoded data1OTHER-encoded data
    Octets...OTHER-encoded data

    The octet numbering in the above table is that used in the cited standard for the octets encoded here.

    The choice determines the value of the Coding standard field. Only the GSM choice is specified by the standard 24.008.

    See Also:
    Serialized Form

    • Constructor Detail

      • MSBearerCapability

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

      • MSBearerCapability

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

      • MSBearerCapability

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

      • MSBearerCapability

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

      • isGSMChosen

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

      • isOtherChosen

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

      • getOther

        public byte[] getOther()
                throws DecodeException
        Gets the value of the field.
        Returns:
        byte[] representation of the field, if choice is the field, else null
        Throws:
        DecodeException - if encoded state cannot be decoded

      • copyOf

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

      • 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