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

Class MSBearerCapability.GSM.Content.Speech

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    Enclosing class:
    MSBearerCapability.GSM.Content
    public static final class MSBearerCapability.GSM.Content.Speech
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class Speech represents the speech forms of a MSBearerCapability. It represents part of a larger octet string; it is not transmitted on a network by itself.

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

     Speech ::= SEQUENCE {
     cTM            CTM OPTIONAL,
     speechVersions SEQUENCE OF SpeechVersion
 }
    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 v9.3.0 (2010-06) §10.5.4.5 pp425-440
    Octet 3a*ext. 0/1Coding (0)CTMSpare (0)Speech version indication
    Octet 3b etc*ext. 0/1Coding (0)Spare (0)Spare (0)Speech version indication

    The octet numbering in the above table is that used in the cited standard for the octets encoded here. Field names ending in ? are booleans: 1 for true, 0 for false.
    See Also:
    Serialized Form

    • Constructor Detail

      • Speech

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

      • Speech

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

      • Speech

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

      • Speech

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

      • toStream

        public void toStream​(DataOutput out)
              throws IOException
        Serializes this object to a stream in a form suitable for reading by {@link #MSBearerCapability.GSM.Content.Speech(DataInput)}.
        Specified by:
        toStream in interface FastSerializable
        Parameters:
        out - the stream to write to
        Throws:
        IOException - if an I/O error occurs

      • hasCTM

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

      • hasSpeechVersions

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

      • 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