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

Class MSBearerCapability

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public class MSBearerCapability
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class MSBearerCapability indicates a requested bearer service to be provided by the mobile network. It represents the ASN.1 OCTET STRING type S5-CommonDataTypes.BearerCapability.gsmBearCap.

The API offered by this class is as if the type were specified in ASN.1 as follows.

 MSBearerCapability ::= CHOICE {
     gSM   GSM,
     other OCTET STRING
 }

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
					Coding standard discriminates...
Case GSM	Octet 3	GSM-encoded data			0	GSM-encoded data
	Octets...	GSM-encoded data
Case OTHER	Octet 3	OTHER-encoded data			1	OTHER-encoded data
	Octets...	OTHER-encoded data

The octet numbering in the above table is that used in the cited standard for the octets encoded here.

The choice determines the value of the Coding standard field. Only the GSM choice is specified by the standard 24.008.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MSBearerCapability.Choice Enumeration of discriminating values.
static class	MSBearerCapability.GSM Class GSM represents the case of a MSBearerCapability that is specified in TS 24.008.

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() Constructs a new MSBearerCapability object with no fields set.
MSBearerCapability(byte[] data) Constructs a new MSBearerCapability object from network-encoded data.
MSBearerCapability(byte[] data, int start, int len) Constructs a new MSBearerCapability object from part of network-encoded data.
MSBearerCapability(DataInput in) Constructs a new MSBearerCapability 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	clone() Constructs a copy of this object and everything reachable from it.
static MSBearerCapability	copyOf(MSBearerCapability 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.Choice	getChoice() Gets the discriminant for which choice is chosen.
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 :discriminant-name to field-value.
MSBearerCapability.GSM	getGSM() Gets the value of the field.
byte[]	getOther() Gets the value of the field.
boolean	isGSMChosen() Tests whether the choice is gSM.
boolean	isOtherChosen() Tests whether the choice is other.
MSBearerCapability	setGSM(MSBearerCapability.GSM value) Sets the value of the field.
MSBearerCapability	setOther(byte[] value) Sets the value of the field.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by MSBearerCapability(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

public MSBearerCapability()

Constructs a new MSBearerCapability object with no fields set.

MSBearerCapability

public MSBearerCapability(byte[] data)

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

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

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

public MSBearerCapability(DataInput in)
                   throws IOException

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

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

getChoice

public MSBearerCapability.Choice getChoice()
                                    throws DecodeException

Gets the discriminant for which choice is chosen.

Returns:

enumerated constant

Throws:

DecodeException - if encoded state cannot be decoded

isGSMChosen

public boolean isGSMChosen()
                    throws DecodeException

Tests whether the choice is gSM.

Returns:

true if chosen, false if not

Throws:

DecodeException - if encoded state cannot be decoded

isOtherChosen

public boolean isOtherChosen()
                      throws DecodeException

Tests whether the choice is other.

Returns:

true if chosen, false if not

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

getGSM

public MSBearerCapability.GSM getGSM()
                              throws DecodeException

Gets the value of the field.

Returns:

GSM representation of the field, if choice is the field, else null

Throws:

DecodeException - if encoded state cannot be decoded

getOther

public byte[] getOther()
                throws DecodeException

Gets the value of the field.

Returns:

byte[] representation of the field, if choice is the field, else null

Throws:

DecodeException - if encoded state cannot be decoded

setGSM

public MSBearerCapability setGSM(MSBearerCapability.GSM value)
                          throws IllegalStateException

Sets the value of the field.

Parameters:

value - GSM representation of the field

Returns:

this

Throws:

IllegalStateException

setOther

public MSBearerCapability setOther(byte[] value)
                            throws IllegalStateException

Sets the value of the field.

Parameters:

value - byte[] representation of the field

Returns:

this

Throws:

IllegalStateException

copyOf

public static MSBearerCapability copyOf(MSBearerCapability 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:

MSBearerCapability

clone

public MSBearerCapability 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 :discriminant-name to field-value. If choice is not set, returns a Map from : to AbstractFieldsObject.FIELD_UNINITIALISED. For a field of primitive type, the field-value is boxed. 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 - the value of this parameter is ignored

Returns:

Map from :discriminant-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 encoding fails

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