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

Class MSBearerCapability.GSM

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

Enclosing class:

MSBearerCapability

public static final class MSBearerCapability.GSM
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class GSM represents the case of a MSBearerCapability that is specified in TS 24.008. 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.

 GSM ::= SEQUENCE {
     transferMode       TransferMode,
     radioChannelReq    RadioChannelReq,
     content            Content
 }

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
	8	7	6	5	4	3	2	1
Octet 3	ext. 0/1	Radio channel requirement		Spare	Transfer mode	Information transfer capability
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
Octet 4*	ext. 1	Compression	Structure		Duplex mode	Configuration	NIRR	Establishment
Octet 5*	ext. 0/1	Access id. (00)		Rate adaption		Signalling access protocol
Octet 5a*	ext. 0/1	Other ITC		Other rate adaption		Spare (000)
Octet 5b*	ext. 1	Hdr/No Hdr	Multiframe	Mode	Logical link identifier	Assignor/ee	Inband negotiation	Spare (0)
Octet 6*	ext. 0/1	Layer 1 id. (01)		User information layer 1 protocol				Async?
Octet 6a*	ext. 0/1	Number of stop bits	Negotiation	Number of data bits	User rate
Octet 6b*	ext. 0/1	Intermediate rate		NIC on Tx	NIC on Rx	Parity
Octet 6c*	ext. 0/1	Connection element		Modem type
Octet 6d*	ext. 0/1	Other modem type		Fixed network user rate
Octet 6e*	ext. 0/1	Acceptable channel codings				Maximum number of traffic channels
Octet 6f*	ext. 0/1	UIMI			Wanted air interface user rate
Octet 6g*	ext. 1	Acceptable channel codings extended			Asymmetry indication		Spare (00)
Octet 7*	ext. 1	Layer 2 id. (10)		User information layer 2 protocol

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 and Description
static class	MSBearerCapability.GSM.Content Class Content is a choice between the speech and non-speech forms of a MSBearerCapability.
static class	MSBearerCapability.GSM.RadioChannelReq MSBearerCapability Radio channel requirement constants.
static class	MSBearerCapability.GSM.TransferMode Enumeration of Information Transfer Mode constants.

Field Summary

Fields inherited from class AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
MSBearerCapability.GSM() Constructs a new GSM object with no fields set.
MSBearerCapability.GSM(byte[] data) Constructs a new GSM object from network-encoded data.
MSBearerCapability.GSM(byte[] data, int start, int len) Constructs a new GSM object from part of network-encoded data.
MSBearerCapability.GSM(DataInput in) Constructs a new GSM object from data deserialized from a stream that was written by toStream(DataOutput).
MSBearerCapability.GSM(MSBearerCapability.GSM.TransferMode transferMode, MSBearerCapability.GSM.RadioChannelReq radioChannelReq, MSBearerCapability.GSM.Content content) Constructs a new GSM object from given values for all fields.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
MSBearerCapability.GSM	clone() Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM	copyOf(MSBearerCapability.GSM 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 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 offset start in the given data.
MSBearerCapability.GSM.Content	getContent() Gets the value of the speech or non-speech content.
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.RadioChannelReq	getRadioChannelReq() Gets the value of the radio channel requirement.
MSBearerCapability.GSM.TransferMode	getTransferMode() Gets the value of the transfer mode.
boolean	hasContent() Tests whether the field Content has a value.
boolean	hasRadioChannelReq() Tests whether the field RadioChannelReq has a value.
boolean	hasTransferMode() Tests whether the field TransferMode has a value.
MSBearerCapability.GSM	setContent(MSBearerCapability.GSM.Content value) Sets the value of the speech or non-speech content.
MSBearerCapability.GSM	setRadioChannelReq(MSBearerCapability.GSM.RadioChannelReq value) Sets the value of the radio channel requirement.
MSBearerCapability.GSM	setTransferMode(MSBearerCapability.GSM.TransferMode value) Sets the value of the transfer mode.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by MSBearerCapability.GSM(DataInput).

Methods inherited from class 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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MSBearerCapability.GSM

public MSBearerCapability.GSM()

Constructs a new GSM object with no fields set.

MSBearerCapability.GSM

public MSBearerCapability.GSM(byte[] data)

Constructs a new GSM 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.GSM

public MSBearerCapability.GSM(byte[] data,
                      int start,
                      int len)

Constructs a new GSM 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.GSM

public MSBearerCapability.GSM(MSBearerCapability.GSM.TransferMode transferMode,
                      MSBearerCapability.GSM.RadioChannelReq radioChannelReq,
                      MSBearerCapability.GSM.Content content)

Constructs a new GSM object from given values for all fields.

Parameters:

transferMode - the transfer mode

radioChannelReq - the radio channel requirement

content - the speech or non-speech content

MSBearerCapability.GSM

public MSBearerCapability.GSM(DataInput in)
                       throws IOException

Constructs a new GSM 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 MSBearerCapability.GSM(DataInput).

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasTransferMode

public boolean hasTransferMode()
                        throws DecodeException

Tests whether the field TransferMode has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasRadioChannelReq

public boolean hasRadioChannelReq()
                           throws DecodeException

Tests whether the field RadioChannelReq has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasContent

public boolean hasContent()
                   throws DecodeException

Tests whether the field Content 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 class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if any mandatory field is not present

getTransferMode

public MSBearerCapability.GSM.TransferMode getTransferMode()
                                                    throws DecodeException

Gets the value of the transfer mode.

Returns:

TransferMode representation of the transfer mode

Throws:

DecodeException - if encoded state cannot be decoded

getRadioChannelReq

public MSBearerCapability.GSM.RadioChannelReq getRadioChannelReq()
                                                          throws DecodeException

Gets the value of the radio channel requirement.

Returns:

RadioChannelReq representation of the radio channel requirement

Throws:

DecodeException - if encoded state cannot be decoded

getContent

public MSBearerCapability.GSM.Content getContent()
                                          throws DecodeException

Gets the value of the speech or non-speech content.

Returns:

Content representation of the speech or non-speech content

Throws:

DecodeException - if encoded state cannot be decoded

setTransferMode

public MSBearerCapability.GSM setTransferMode(MSBearerCapability.GSM.TransferMode value)
                                       throws IllegalStateException

Sets the value of the transfer mode.

Parameters:

value - TransferMode representation of the transfer mode

Returns:

this

Throws:

IllegalStateException

setRadioChannelReq

public MSBearerCapability.GSM setRadioChannelReq(MSBearerCapability.GSM.RadioChannelReq value)
                                          throws IllegalStateException

Sets the value of the radio channel requirement.

Parameters:

value - RadioChannelReq representation of the radio channel requirement

Returns:

this

Throws:

IllegalStateException

setContent

public MSBearerCapability.GSM setContent(MSBearerCapability.GSM.Content value)
                                  throws IllegalStateException

Sets the value of the speech or non-speech content.

Parameters:

value - Content representation of the speech or non-speech content

Returns:

this

Throws:

IllegalStateException

copyOf

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

GSM

clone

public MSBearerCapability.GSM clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

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 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. 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

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if encoding fails

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if too few or too many octets to be decoded