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

Class MSBearerCapability.GSM.Content.NonSpeech

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

Enclosing class:

MSBearerCapability.GSM.Content

public static final class MSBearerCapability.GSM.Content.NonSpeech
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class NonSpeech represents the non-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.

 NonSpeech ::= SEQUENCE {
     transferCapability TransferCapability,
     dataProtocol       DataProtocol       OPTIONAL,
     access             Access             OPTIONAL,
     layer1Capability   Layer1Capability   OPTIONAL,
     layer2Protocol     Layer2Protocol     OPTIONAL
 }

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	Spare					Information transfer capability
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.NonSpeech.Access Class Access represents flow control of data within a MSBearerCapability.
static class	MSBearerCapability.GSM.Content.NonSpeech.DataProtocol Class DataProtocol represents the non-speech coding of data within a MSBearerCapability.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability Class Layer1Capability represents the layer 1 capability within a MSBearerCapability.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer2Protocol User Information Layer 2 Protocol constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.TransferCapability MSBearerCapability Information transfer capability 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.Content.NonSpeech() Constructs a new NonSpeech object with no fields set.
MSBearerCapability.GSM.Content.NonSpeech(byte[] data) Constructs a new NonSpeech object from network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech(byte[] data, int start, int len) Constructs a new NonSpeech object from part of network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech(DataInput in) Constructs a new NonSpeech object from data deserialized from a stream that was written by toStream(DataOutput).

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
MSBearerCapability.GSM.Content.NonSpeech	clone() Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM.Content.NonSpeech	copyOf(MSBearerCapability.GSM.Content.NonSpeech 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.
MSBearerCapability.GSM.Content.NonSpeech.Access	getAccess() Gets the value of the access indentifier.
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.NonSpeech.DataProtocol	getDataProtocol() Gets the value of the data protocol.
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.NonSpeech.Layer1Capability	getLayer1Capability() Gets the value of the layer 1 capability.
MSBearerCapability.GSM.Content.NonSpeech.Layer2Protocol	getLayer2Protocol() Gets the value of the user information layer 2 protocol.
MSBearerCapability.GSM.Content.NonSpeech.TransferCapability	getTransferCapability() Gets the value of the information transfer capability.
boolean	hasAccess() Tests whether the field Access has a value.
boolean	hasDataProtocol() Tests whether the field DataProtocol has a value.
boolean	hasLayer1Capability() Tests whether the field Layer1Capability has a value.
boolean	hasLayer2Protocol() Tests whether the field Layer2Protocol has a value.
boolean	hasTransferCapability() Tests whether the field TransferCapability has a value.
MSBearerCapability.GSM.Content.NonSpeech	setAccess(MSBearerCapability.GSM.Content.NonSpeech.Access value) Sets the value of the access indentifier.
MSBearerCapability.GSM.Content.NonSpeech	setDataProtocol(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol value) Sets the value of the data protocol.
MSBearerCapability.GSM.Content.NonSpeech	setLayer1Capability(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability value) Sets the value of the layer 1 capability.
MSBearerCapability.GSM.Content.NonSpeech	setLayer2Protocol(MSBearerCapability.GSM.Content.NonSpeech.Layer2Protocol value) Sets the value of the user information layer 2 protocol.
void	setReadOnly() Sets this and all its fields to be immutable.
MSBearerCapability.GSM.Content.NonSpeech	setTransferCapability(MSBearerCapability.GSM.Content.NonSpeech.TransferCapability value) Sets the value of the information transfer capability.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by MSBearerCapability.GSM.Content.NonSpeech(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

Methods inherited from class java.lang.Object

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

Constructor Detail

MSBearerCapability.GSM.Content.NonSpeech

public MSBearerCapability.GSM.Content.NonSpeech()

Constructs a new NonSpeech object with no fields set.

MSBearerCapability.GSM.Content.NonSpeech

public MSBearerCapability.GSM.Content.NonSpeech(byte[] data)

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

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

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

public MSBearerCapability.GSM.Content.NonSpeech(DataInput in)
                                         throws IOException

Constructs a new NonSpeech 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.Content.NonSpeech(DataInput).

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasTransferCapability

public boolean hasTransferCapability()
                              throws DecodeException

Tests whether the field TransferCapability has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasDataProtocol

public boolean hasDataProtocol()
                        throws DecodeException

Tests whether the field DataProtocol has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasAccess

public boolean hasAccess()
                  throws DecodeException

Tests whether the field Access has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasLayer1Capability

public boolean hasLayer1Capability()
                            throws DecodeException

Tests whether the field Layer1Capability has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasLayer2Protocol

public boolean hasLayer2Protocol()
                          throws DecodeException

Tests whether the field Layer2Protocol 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

getTransferCapability

public MSBearerCapability.GSM.Content.NonSpeech.TransferCapability getTransferCapability()
                                                                                  throws DecodeException

Gets the value of the information transfer capability.

Returns:

TransferCapability representation of the information transfer capability

Throws:

DecodeException - if encoded state cannot be decoded

getDataProtocol

public MSBearerCapability.GSM.Content.NonSpeech.DataProtocol getDataProtocol()
                                                                      throws DecodeException

Gets the value of the data protocol.

Returns:

DataProtocol representation of the data protocol

Throws:

DecodeException - if encoded state cannot be decoded

getAccess

public MSBearerCapability.GSM.Content.NonSpeech.Access getAccess()
                                                          throws DecodeException

Gets the value of the access indentifier.

Returns:

Access representation of the access indentifier

Throws:

DecodeException - if encoded state cannot be decoded

getLayer1Capability

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability getLayer1Capability()
                                                                              throws DecodeException

Gets the value of the layer 1 capability.

Returns:

Layer1Capability representation of the layer 1 capability

Throws:

DecodeException - if encoded state cannot be decoded

getLayer2Protocol

public MSBearerCapability.GSM.Content.NonSpeech.Layer2Protocol getLayer2Protocol()
                                                                          throws DecodeException

Gets the value of the user information layer 2 protocol.

Returns:

Layer2Protocol representation of the user information layer 2 protocol

Throws:

DecodeException - if encoded state cannot be decoded

setTransferCapability

public MSBearerCapability.GSM.Content.NonSpeech setTransferCapability(MSBearerCapability.GSM.Content.NonSpeech.TransferCapability value)
                                                               throws IllegalStateException

Sets the value of the information transfer capability.

Parameters:

value - TransferCapability representation of the information transfer capability

Returns:

this

Throws:

IllegalStateException

setDataProtocol

public MSBearerCapability.GSM.Content.NonSpeech setDataProtocol(MSBearerCapability.GSM.Content.NonSpeech.DataProtocol value)
                                                         throws IllegalStateException

Sets the value of the data protocol.

Parameters:

value - DataProtocol representation of the data protocol

Returns:

this

Throws:

IllegalStateException

setAccess

public MSBearerCapability.GSM.Content.NonSpeech setAccess(MSBearerCapability.GSM.Content.NonSpeech.Access value)
                                                   throws IllegalStateException

Sets the value of the access indentifier.

Parameters:

value - Access representation of the access indentifier

Returns:

this

Throws:

IllegalStateException

setLayer1Capability

public MSBearerCapability.GSM.Content.NonSpeech setLayer1Capability(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability value)
                                                             throws IllegalStateException

Sets the value of the layer 1 capability.

Parameters:

value - Layer1Capability representation of the layer 1 capability

Returns:

this

Throws:

IllegalStateException

setLayer2Protocol

public MSBearerCapability.GSM.Content.NonSpeech setLayer2Protocol(MSBearerCapability.GSM.Content.NonSpeech.Layer2Protocol value)
                                                           throws IllegalStateException

Sets the value of the user information layer 2 protocol.

Parameters:

value - Layer2Protocol representation of the user information layer 2 protocol

Returns:

this

Throws:

IllegalStateException

copyOf

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

NonSpeech

clone

public MSBearerCapability.GSM.Content.NonSpeech 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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

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 Information transfer capability is speech

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