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

Class MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability

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

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

MSBearerCapability.GSM.Content.NonSpeech

public static final class MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability
extends AbstractLazyEncodedByteArray

Class Layer1Capability represents the layer 1 capability within 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.

 Layer1Capability ::= SEQUENCE {
     asynchronous   BOOLEAN,
     layer1Protocol Layer1Protocol,
     o6a            O6a 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 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)

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.

There is a static condition in standard 24.008 that says if octet 6 is present then octet 6a shall also be present, in the GSM encoding. Contradicting that, the standard allows the ext bit in octet 6 to be 1, which would indicate that there is no following octet 6a. As a compromise, this API offers field O6a as an OPTIONAL field, but with this recommendation: you should always provide a value for field O6a.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.Layer1Protocol User Information Layer 1 Protocol constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a Class O6a represents octets 6a to 6g within a MSBearerCapability.Layer1Capability It represents part of a larger octet string; it is not transmitted on a network by itself.

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.Layer1Capability() Constructs a new Layer1Capability object with no fields set.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(byte[] data) Constructs a new Layer1Capability object from network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(byte[] data, int start, int len) Constructs a new Layer1Capability object from part of network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(DataInput in) Constructs a new Layer1Capability 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.Layer1Capability	clone() Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability	copyOf(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability 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.
boolean	getAsynchronous() Gets the value of synchronous/asynchronous.
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.
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.Layer1Protocol	getLayer1Protocol() Gets the value of the user information layer 1 protocol.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a	getO6a() Gets the value of the octets 6a*..6g*.
boolean	hasAsynchronous() Tests whether the field Asynchronous has a value.
boolean	hasLayer1Protocol() Tests whether the field Layer1Protocol has a value.
boolean	hasO6a() Tests whether the field O6a has a value.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability	setAsynchronous(boolean value) Sets the value of synchronous/asynchronous.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability	setAsynchronousPresent(boolean flag) Sets the presence or absence of the field Asynchronous.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability	setLayer1Protocol(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.Layer1Protocol value) Sets the value of the user information layer 1 protocol.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability	setO6a(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a value) Sets the value of the octets 6a*..6g*.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability(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.Content.NonSpeech.Layer1Capability

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability()

Constructs a new Layer1Capability object with no fields set.

MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability

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

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

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

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

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

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

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasAsynchronous

public boolean hasAsynchronous()
                        throws DecodeException

Tests whether the field Asynchronous has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setAsynchronousPresent

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability setAsynchronousPresent(boolean flag)
                                                                                 throws IllegalStateException

Sets the presence or absence of the field Asynchronous.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

hasLayer1Protocol

public boolean hasLayer1Protocol()
                          throws DecodeException

Tests whether the field Layer1Protocol has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasO6a

public boolean hasO6a()
               throws DecodeException

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

getAsynchronous

public boolean getAsynchronous()
                        throws DecodeException

Gets the value of synchronous/asynchronous.

Returns:

boolean representation of synchronous/asynchronous

Throws:

DecodeException - if encoded state cannot be decoded

getLayer1Protocol

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.Layer1Protocol getLayer1Protocol()
                                                                                           throws DecodeException

Gets the value of the user information layer 1 protocol.

Returns:

Layer1Protocol representation of the user information layer 1 protocol

Throws:

DecodeException - if encoded state cannot be decoded

getO6a

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a getO6a()
                                                                     throws DecodeException

Gets the value of the octets 6a*..6g*.

Returns:

O6a representation of the octets 6a*..6g*

Throws:

DecodeException - if encoded state cannot be decoded

setAsynchronous

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

Sets the value of synchronous/asynchronous.

Parameters:

value - boolean representation of synchronous/asynchronous

Returns:

this

Throws:

IllegalStateException

setLayer1Protocol

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

Sets the value of the user information layer 1 protocol.

Parameters:

value - Layer1Protocol representation of the user information layer 1 protocol

Returns:

this

Throws:

IllegalStateException

setO6a

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

Sets the value of the octets 6a*..6g*.

Parameters:

value - O6a representation of the octets 6a*..6g*

Returns:

this

Throws:

IllegalStateException

copyOf

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

Layer1Capability

clone

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability 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 choice does not match already encoded coding standard

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