Class MSBearerCapability.GSM.Content.Speech
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.cc.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/1 Coding (0) CTM Spare (0) Speech version indication Octet 3b etc* ext. 0/1 Coding (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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MSBearerCapability.GSM.Content.Speech.CTM
Enumeration of CTM constants.static class
MSBearerCapability.GSM.Content.Speech.SpeechVersion
SpeechVersion constants.
-
Field Summary
-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
isDecoded
-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject
encoded
-
Fields inherited from class com.opencloud.util.AbstractFieldsObject
FIELD_ABSENT, FIELD_UNINITIALISED
-
-
Constructor Summary
Constructors Constructor Description Speech()
Constructs a new Speech object with no fields set.Speech(byte[] data)
Constructs a new Speech object from network-encoded data.Speech(byte[] data, int start, int len)
Constructs a new Speech object from part of network-encoded data.Speech(DataInput in)
Constructs a new Speech object from data deserialized from a stream that was written bytoStream(DataOutput)
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkFieldsSet()
Checks that all mandatory fields are present.MSBearerCapability.GSM.Content.Speech
clone()
Constructs a copy of this object and everything reachable from it.static MSBearerCapability.GSM.Content.Speech
copyOf(MSBearerCapability.GSM.Content.Speech 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.protected void
decode()
Computes the decoded form from the encoded form.protected void
encode()
Computes the encoded form of the state from the decoded form.protected boolean
encodedIsInvalid()
Determines whether the encoded form is invalid.static int
getContainedLength(byte[] data, int start, int len)
Determines the length of the encoded value that commences at offsetstart
in the givendata
.MSBearerCapability.GSM.Content.Speech.CTM
getCTM()
Gets the value of the CTM text telephony indication.byte[]
getEncodedForm()
Gets the encoded form.static FieldAccessor[]
getFieldAccessors()
Gets a new array of the accessors for fields of this type.Map<String,Object>
getFieldsMap(boolean withAbsents)
Gets a Map from field-name to field-value for the fields of a sequence.MSBearerCapability.GSM.Content.Speech.SpeechVersion[]
getSpeechVersions()
Gets the value of the speech version indications.boolean
hasCTM()
Tests whether the field CTM has a value.boolean
hasSpeechVersions()
Tests whether the field SpeechVersions has a value.MSBearerCapability.GSM.Content.Speech
setCTM(MSBearerCapability.GSM.Content.Speech.CTM value)
Sets the value of the CTM text telephony indication.MSBearerCapability.GSM.Content.Speech
setSpeechVersions(MSBearerCapability.GSM.Content.Speech.SpeechVersion[] value)
Sets the value of the speech version indications.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by {@link #MSBearerCapability.GSM.Content.Speech(DataInput)}.-
Methods inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
checkDecode, checkModifyAndDecode
-
Methods inherited from class com.opencloud.util.AbstractFieldsObject
equals, hashCode, toString
-
Methods inherited from class com.opencloud.util.AbstractDataObject
checkModify, isReadOnly, setReadOnly
-
-
-
-
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 indexstart
and islen
bytes long. The data is not decoded and might not be decodable.- Parameters:
data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictable- Throws:
NullPointerException
- if data is nullIllegalArgumentException
- 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 bytoStream(DataOutput)
.- Parameters:
in
- the stream to read from- Throws:
EOFException
- if reading is pre-empted by end-of-fileIOException
- 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 interfaceFastSerializable
- 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
-
checkFieldsSet
public void checkFieldsSet() throws EncodeException
Checks that all mandatory fields are present. Should be called immediately before all calls to encode().- Specified by:
checkFieldsSet
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if any mandatory field is not present
-
getCTM
public MSBearerCapability.GSM.Content.Speech.CTM getCTM() throws DecodeException
Gets the value of the CTM text telephony indication.- Returns:
- CTM representation of the CTM text telephony indication
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getSpeechVersions
public MSBearerCapability.GSM.Content.Speech.SpeechVersion[] getSpeechVersions() throws DecodeException
Gets the value of the speech version indications.- Returns:
- SpeechVersion[] representation of the speech version indications
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setCTM
public MSBearerCapability.GSM.Content.Speech setCTM(MSBearerCapability.GSM.Content.Speech.CTM value) throws IllegalStateException
Sets the value of the CTM text telephony indication.- Parameters:
value
- CTM representation of the CTM text telephony indication- Returns:
- this
- Throws:
IllegalStateException
-
setSpeechVersions
public MSBearerCapability.GSM.Content.Speech setSpeechVersions(MSBearerCapability.GSM.Content.Speech.SpeechVersion[] value) throws IllegalStateException
Sets the value of the speech version indications.- Parameters:
value
- SpeechVersion[] representation of the speech version indications- Returns:
- this
- Throws:
IllegalStateException
-
copyOf
public static MSBearerCapability.GSM.Content.Speech copyOf(MSBearerCapability.GSM.Content.Speech 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:
- Speech
-
clone
public MSBearerCapability.GSM.Content.Speech clone()
Constructs a copy of this object and everything reachable from it.- Specified by:
clone
in interfaceDataObject
- Specified by:
clone
in classAbstractDataObject
- Returns:
- copy of object
-
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 classAbstractFieldsObject
- 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 offsetstart
in the givendata
. 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 datastart
- index into data where value commenceslen
- length in data to be considered- Returns:
- len, or 0 if encoded value is not long enough
-
encode
protected void encode() throws EncodeException
Computes the encoded form of the state from the decoded form.- Specified by:
encode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if encoding fails
-
decode
protected void decode() throws DecodeException
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if too few or too many octets to be decoded
-
-