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

Class MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c

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.O6a.O6b.O6c

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b

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

Class O6c represents data that is relevant to octets 6c* to 6g*. 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.

 O6c ::= SEQUENCE {
     modemType         ModemType,
     connectionElement ConnectionElement,
     o6d               O6d 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 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.ConnectionElement Enumeration of ConnectionElement constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.ModemType Modem Type constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d Class O6d represents data that is relevant to octets 6d* to 6g*.

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.O6a.O6b.O6c() Constructs a new O6c object with no fields set.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c(byte[] data) Constructs a new O6c object from network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c(byte[] data, int start, int len) Constructs a new O6c object from part of network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c(DataInput in) Constructs a new O6c 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.O6a.O6b.O6c	clone() Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c	copyOf(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c 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.Layer1Capability.O6a.O6b.O6c.ConnectionElement	getConnectionElement() Gets the value of the connection element.
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.O6a.O6b.O6c.ModemType	getModemType() Gets the value of the modem type.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d	getO6d() Gets the value of the octets 6d*..6g*.
boolean	hasConnectionElement() Tests whether the field ConnectionElement has a value.
boolean	hasModemType() Tests whether the field ModemType has a value.
boolean	hasO6d() Tests whether the field O6d has a value.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c	setConnectionElement(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.ConnectionElement value) Sets the value of the connection element.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c	setModemType(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.ModemType value) Sets the value of the modem type.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c	setO6d(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d value) Sets the value of the octets 6d*..6g*.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c(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.O6a.O6b.O6c

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c()

Constructs a new O6c object with no fields set.

MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c

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

Constructs a new O6c 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.O6a.O6b.O6c

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

Constructs a new O6c 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.O6a.O6b.O6c

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

Constructs a new O6c 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.O6a.O6b.O6c(DataInput).

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasModemType

public boolean hasModemType()
                     throws DecodeException

Tests whether the field ModemType has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasConnectionElement

public boolean hasConnectionElement()
                             throws DecodeException

Tests whether the field ConnectionElement has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasO6d

public boolean hasO6d()
               throws DecodeException

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

getModemType

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.ModemType getModemType()
                                                                                             throws DecodeException

Gets the value of the modem type.

Returns:

ModemType representation of the modem type

Throws:

DecodeException - if encoded state cannot be decoded

getConnectionElement

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.ConnectionElement getConnectionElement()
                                                                                                             throws DecodeException

Gets the value of the connection element.

Returns:

ConnectionElement representation of the connection element

Throws:

DecodeException - if encoded state cannot be decoded

getO6d

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d getO6d()
                                                                                 throws DecodeException

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

Returns:

O6d representation of the octets 6d*..6g*

Throws:

DecodeException - if encoded state cannot be decoded

setModemType

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c setModemType(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.ModemType value)
                                                                                   throws IllegalStateException

Sets the value of the modem type.

Parameters:

value - ModemType representation of the modem type

Returns:

this

Throws:

IllegalStateException

setConnectionElement

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c setConnectionElement(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.ConnectionElement value)
                                                                                           throws IllegalStateException

Sets the value of the connection element.

Parameters:

value - ConnectionElement representation of the connection element

Returns:

this

Throws:

IllegalStateException

setO6d

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c setO6d(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d value)
                                                                             throws IllegalStateException

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

Parameters:

value - O6d representation of the octets 6d*..6g*

Returns:

this

Throws:

IllegalStateException

copyOf

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

O6c

clone

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c 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 field values cannot be encoded

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