Class MSClassmark
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.cc.MSClassmark
-
- All Implemented Interfaces:
DataObject
,FastSerializable
,Serializable
public final class MSClassmark extends AbstractLazyEncodedByteArray implements FastSerializable
Class MSClassmark represents a Mobile Station Classmark, which provides the network with information concerning aspects of high priority of the mobile station equipment. Three formats of MSClassmark are defined in 3GPP TS 24.008 v9.3.0.The API offered by this class is as if the type were specified in ASN.1 as follows. Helper APIs are defined in nested classes for two of the three formats.
MSClassmark ::= CHOICE { mSClassmark1 MSClassmark1, mSClassmark2 MSClassmark2, mSClassmark3 OCTET STRING }
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MSClassmark.Choice
Enumeration of discriminating values.static class
MSClassmark.MSClassmark1
Class MSClassmark1 provides the network with information concerning aspects of high priority of the mobile station equipment, coded in MSClassmark1 format.static class
MSClassmark.MSClassmark2
Class MSClassmark2 provides the network with information concerning aspects of high priority of the mobile station equipment, coded in MSClassmark2 format.
-
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 MSClassmark()
Constructs a new MSClassmark object with no fields set.MSClassmark(byte[] data)
Constructs a new MSClassmark object from network-encoded data.MSClassmark(byte[] data, int start, int len)
Constructs a new MSClassmark object from part of network-encoded data.MSClassmark(DataInput in)
Constructs a new MSClassmark object from data deserialized from a stream that was written bytoStream(DataOutput)
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkFieldsSet()
Checks that all mandatory fields are present.MSClassmark
clone()
Constructs a copy of this object and everything reachable from it.static MSClassmark
copyOf(MSClassmark 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.MSClassmark.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 offsetstart
in the givendata
.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.MSClassmark.MSClassmark1
getMSClassmark1()
Gets the value of MS Classmark 1.MSClassmark.MSClassmark2
getMSClassmark2()
Gets the value of MS Classmark 2.byte[]
getMSClassmark3()
Gets the value of MS Classmark 3.boolean
isMSClassmark1Chosen()
Tests whether the choice is mSClassmark1.boolean
isMSClassmark2Chosen()
Tests whether the choice is mSClassmark2.boolean
isMSClassmark3Chosen()
Tests whether the choice is mSClassmark3.MSClassmark
setMSClassmark1(MSClassmark.MSClassmark1 value)
Sets the value of MS Classmark 1.MSClassmark
setMSClassmark2(MSClassmark.MSClassmark2 value)
Sets the value of MS Classmark 2.MSClassmark
setMSClassmark3(byte[] value)
Sets the value of MS Classmark 3.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading byMSClassmark(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
-
-
-
-
Constructor Detail
-
MSClassmark
public MSClassmark()
Constructs a new MSClassmark object with no fields set.
-
MSClassmark
public MSClassmark(byte[] data)
Constructs a new MSClassmark 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
-
MSClassmark
public MSClassmark(byte[] data, int start, int len)
Constructs a new MSClassmark object from part of network-encoded data. The part starts at indexstart
and islen
bytes long. The data is not decoded and might not be decodable.- Parameters:
data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictable- Throws:
NullPointerException
- if data is nullIllegalArgumentException
- if len is negative
-
MSClassmark
public MSClassmark(DataInput in) throws IOException
Constructs a new MSClassmark object from data deserialized from a stream that was written bytoStream(DataOutput)
.- Parameters:
in
- the stream to read from- Throws:
EOFException
- if reading is pre-empted by end-of-fileIOException
- 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 byMSClassmark(DataInput)
.- Specified by:
toStream
in interfaceFastSerializable
- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
getChoice
public MSClassmark.Choice getChoice() throws DecodeException
Gets the discriminant for which choice is chosen.- Returns:
- enumerated constant
- Throws:
DecodeException
- if encoded state cannot be decoded
-
isMSClassmark1Chosen
public boolean isMSClassmark1Chosen() throws DecodeException
Tests whether the choice is mSClassmark1.- Returns:
- true if chosen, false if not
- Throws:
DecodeException
- if encoded state cannot be decoded
-
isMSClassmark2Chosen
public boolean isMSClassmark2Chosen() throws DecodeException
Tests whether the choice is mSClassmark2.- Returns:
- true if chosen, false if not
- Throws:
DecodeException
- if encoded state cannot be decoded
-
isMSClassmark3Chosen
public boolean isMSClassmark3Chosen() throws DecodeException
Tests whether the choice is mSClassmark3.- 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 classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if any mandatory field is not present
-
getMSClassmark1
public MSClassmark.MSClassmark1 getMSClassmark1() throws DecodeException
Gets the value of MS Classmark 1.- Returns:
- MSClassmark1 representation of MS Classmark 1, if choice is MS Classmark 1, else null
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getMSClassmark2
public MSClassmark.MSClassmark2 getMSClassmark2() throws DecodeException
Gets the value of MS Classmark 2.- Returns:
- MSClassmark2 representation of MS Classmark 2, if choice is MS Classmark 2, else null
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getMSClassmark3
public byte[] getMSClassmark3() throws DecodeException
Gets the value of MS Classmark 3.- Returns:
- byte[] representation of MS Classmark 3, if choice is MS Classmark 3, else null
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setMSClassmark1
public MSClassmark setMSClassmark1(MSClassmark.MSClassmark1 value) throws IllegalStateException
Sets the value of MS Classmark 1.- Parameters:
value
- MSClassmark1 representation of MS Classmark 1- Returns:
- this
- Throws:
IllegalStateException
-
setMSClassmark2
public MSClassmark setMSClassmark2(MSClassmark.MSClassmark2 value) throws IllegalStateException
Sets the value of MS Classmark 2.- Parameters:
value
- MSClassmark2 representation of MS Classmark 2- Returns:
- this
- Throws:
IllegalStateException
-
setMSClassmark3
public MSClassmark setMSClassmark3(byte[] value) throws IllegalStateException
Sets the value of MS Classmark 3.- Parameters:
value
- byte[] representation of MS Classmark 3- Returns:
- this
- Throws:
IllegalStateException
-
copyOf
public static MSClassmark copyOf(MSClassmark 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:
- MSClassmark
-
clone
public MSClassmark clone()
Constructs a copy of this object and everything reachable from it.- Specified by:
clone
in interfaceDataObject
- Specified by:
clone
in classAbstractDataObject
- 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 classAbstractFieldsObject
- 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 offsetstart
in the givendata
. The value is not fully decoded and might not be decodable. Values of this type are of variable length, so the given length is returned if the data is long enough, otherwise 0 is returned.- Parameters:
data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be considered- Returns:
- len, or 0 if encoded value is not long enough
-
encode
protected void encode() throws EncodeException
Computes the encoded form from the decoded form.- Specified by:
encode
in classAbstractLazyEncodedDataObject<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 classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if too few or too many octets to be decoded
-
-