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

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

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

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

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

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

Class O6f represents data that is relevant to Octets 6f 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.

 O6f ::= SEQUENCE {
     wantedAirInterface WantedAirInterface,
     uimi               UIMI,
     o6g                O6g 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 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	Description
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f.O6g	Class O6g represents the data of Octet 6g in an MSBearerCapability.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f.UIMI	UIMI constants.
static class	MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f.WantedAirInterface	WantedAirInterface constants.

Field Summary

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject

isDecoded

Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject

encoded

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
O6f()	Constructs a new O6f object with no fields set.
O6f(byte[] data)	Constructs a new O6f object from network-encoded data.
O6f(byte[] data, int start, int len)	Constructs a new O6f object from part of network-encoded data.
O6f(DataInput in)	Constructs a new O6f object from data deserialized from a stream that was written by toStream(DataOutput).

Method Summary

Modifier and Type	Method	Description
void	checkFieldsSet()	Checks that all mandatory fields are present.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f	clone()	Constructs a copy of this object and everything reachable from it.
static MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f	copyOf(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f 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.O6e.O6f.O6g	getO6g()	Gets the value of the optional octet 6g*.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f.UIMI	getUIMI()	Gets the value of the user initiated modification indication.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f.WantedAirInterface	getWantedAirInterface()	Gets the value of the wanted air interface user rate.
boolean	hasO6g()	Tests whether the field O6g has a value.
boolean	hasUIMI()	Tests whether the field UIMI has a value.
boolean	hasWantedAirInterface()	Tests whether the field WantedAirInterface has a value.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f	setO6g(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f.O6g value)	Sets the value of the optional octet 6g*.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f	setUIMI(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f.UIMI value)	Sets the value of the user initiated modification indication.
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f	setWantedAirInterface(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f.WantedAirInterface value)	Sets the value of the wanted air interface user rate.
void	toStream(DataOutput out)	Serializes this object to a stream in a form suitable for reading by {@link #MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f(DataInput)}.

Methods inherited from class com.opencloud.slee.resources.cgin.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

O6f

public O6f()

Constructs a new O6f object with no fields set.

O6f

public O6f(byte[] data)

Constructs a new O6f 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

O6f

public O6f(byte[] data,
           int start,
           int len)

Constructs a new O6f 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

O6f

public O6f(DataInput in)
    throws IOException

Constructs a new O6f 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 {@link #MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f(DataInput)}.

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasWantedAirInterface

public boolean hasWantedAirInterface()
                              throws DecodeException

Tests whether the field WantedAirInterface has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasUIMI

public boolean hasUIMI()
                throws DecodeException

Tests whether the field UIMI has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasO6g

public boolean hasO6g()
               throws DecodeException

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

getWantedAirInterface

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

Gets the value of the wanted air interface user rate.

Returns:

WantedAirInterface representation of the wanted air interface user rate

Throws:

DecodeException - if encoded state cannot be decoded

getUIMI

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

Gets the value of the user initiated modification indication.

Returns:

UIMI representation of the user initiated modification indication

Throws:

DecodeException - if encoded state cannot be decoded

getO6g

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

Gets the value of the optional octet 6g*.

Returns:

O6g representation of the optional octet 6g*

Throws:

DecodeException - if encoded state cannot be decoded

setWantedAirInterface

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

Sets the value of the wanted air interface user rate.

Parameters:

value - WantedAirInterface representation of the wanted air interface user rate

Returns:

this

Throws:

IllegalStateException

setUIMI

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

Sets the value of the user initiated modification indication.

Parameters:

value - UIMI representation of the user initiated modification indication

Returns:

this

Throws:

IllegalStateException

setO6g

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

Sets the value of the optional octet 6g*.

Parameters:

value - O6g representation of the optional octet 6g*

Returns:

this

Throws:

IllegalStateException

copyOf

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

O6f

clone

public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b.O6c.O6d.O6e.O6f 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 any mandatory field is out of range

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if decoding fails