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

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

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

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

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

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

Class O6d represents data that is relevant to octets 6d* 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.

 O6d ::= SEQUENCE {
     fixedUserRate  FixedUserRate,
     otherModemType OtherModemType,
     o6e            O6e 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 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.O6d.FixedUserRate FixedUserRate constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e Class O6e represents data that is relevant to octets 6e* to 6g*.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.OtherModemType OtherModemType 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.Layer1Capability.O6a.O6b.O6c.O6d() Constructs a new O6d object with no fields set.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d(byte[] data) Constructs a new O6d object from network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d(byte[] data, int start, int len) Constructs a new O6d object from part of network-encoded data.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d(DataInput in) Constructs a new O6d 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.O6d	clone() Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d	copyOf(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d 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.
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.O6d.FixedUserRate	getFixedUserRate() Gets the value of the fixed network user rate.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e	getO6e() Gets the value of the optional octets 6e*..6g*.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.OtherModemType	getOtherModemType() Gets the value of the other modem type.
boolean	hasFixedUserRate() Tests whether the field FixedUserRate has a value.
boolean	hasO6e() Tests whether the field O6e has a value.
boolean	hasOtherModemType() Tests whether the field OtherModemType has a value.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d	setFixedUserRate(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.FixedUserRate value) Sets the value of the fixed network user rate.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d	setO6e(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e value) Sets the value of the optional octets 6e*..6g*.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d	setOtherModemType(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.OtherModemType value) Sets the value of the other modem type.
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.O6d(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.O6d

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

Constructs a new O6d object with no fields set.

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

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

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

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

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

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

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

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasFixedUserRate

public boolean hasFixedUserRate()
                         throws DecodeException

Tests whether the field FixedUserRate has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasOtherModemType

public boolean hasOtherModemType()
                          throws DecodeException

Tests whether the field OtherModemType has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasO6e

public boolean hasO6e()
               throws DecodeException

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

getFixedUserRate

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

Gets the value of the fixed network user rate.

Returns:

FixedUserRate representation of the fixed network user rate

Throws:

DecodeException - if encoded state cannot be decoded

getOtherModemType

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

Gets the value of the other modem type.

Returns:

OtherModemType representation of the other modem type

Throws:

DecodeException - if encoded state cannot be decoded

getO6e

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

Gets the value of the optional octets 6e*..6g*.

Returns:

O6e representation of the optional octets 6e*..6g*

Throws:

DecodeException - if encoded state cannot be decoded

setFixedUserRate

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

Sets the value of the fixed network user rate.

Parameters:

value - FixedUserRate representation of the fixed network user rate

Returns:

this

Throws:

IllegalStateException

setOtherModemType

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

Sets the value of the other modem type.

Parameters:

value - OtherModemType representation of the other modem type

Returns:

this

Throws:

IllegalStateException

setO6e

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

Sets the value of the optional octets 6e*..6g*.

Parameters:

value - O6e representation of the optional octets 6e*..6g*

Returns:

this

Throws:

IllegalStateException

copyOf

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

O6d

clone

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d 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