public class MSBearerCapability extends AbstractLazyEncodedByteArray implements FastSerializable
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 choice determines the value of the Coding standard field. Only the GSM choice is specified by the standard 24.008.
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.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
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) . |
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) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly, setReadOnly
public MSBearerCapability()
public MSBearerCapability(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic MSBearerCapability(byte[] data, int start, int len)
start
and is len
bytes long.
The data is not decoded and might not be decodable.data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictableNullPointerException
- if data is nullIllegalArgumentException
- if len is negativepublic MSBearerCapability(DataInput in) throws IOException
toStream(DataOutput)
.in
- the stream to read fromEOFException
- if reading is pre-empted by end-of-fileIOException
- if the data cannot be readpublic void toStream(DataOutput out) throws IOException
MSBearerCapability(DataInput)
.toStream
in interface FastSerializable
out
- the stream to write toIOException
- if an I/O error occurspublic MSBearerCapability.Choice getChoice() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean isGSMChosen() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic boolean isOtherChosen() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic void checkFieldsSet() throws EncodeException
checkFieldsSet
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if any mandatory field is not presentpublic MSBearerCapability.GSM getGSM() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic byte[] getOther() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic MSBearerCapability setGSM(MSBearerCapability.GSM value) throws IllegalStateException
value
- GSM representation of the fieldIllegalStateException
public MSBearerCapability setOther(byte[] value) throws IllegalStateException
value
- byte[] representation of the fieldIllegalStateException
public static MSBearerCapability copyOf(MSBearerCapability from)
from
- the object from which to copypublic MSBearerCapability clone()
clone
in interface DataObject
clone
in class AbstractDataObject
public static FieldAccessor[] getFieldAccessors()
public Map<String,Object> getFieldsMap(boolean withAbsents)
getFieldsMap
in class AbstractFieldsObject
withAbsents
- the value of this parameter is ignoredprotected boolean encodedIsInvalid()
public byte[] getEncodedForm() throws EncodeException
EncodeException
- if encoding failspublic static int getContainedLength(byte[] data, int start, int len)
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.data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be consideredNullPointerException
- if data is nullprotected void encode() throws EncodeException
encode
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if encoding failsprotected void decode() throws DecodeException
decode
in class AbstractLazyEncodedDataObject<byte[]>
DecodeException
- if too few or too many octets to be decoded