Class SMSDataCodingScheme.MessageCodingScheme
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<T>
-
- AbstractLazyEncodedNamedInteger<SMSDataCodingScheme.MessageCodingScheme.EncodedValue>
-
- com.opencloud.slee.resources.in.datatypes.sms.SMSDataCodingScheme.MessageCodingScheme
-
- All Implemented Interfaces:
DataObject
,Serializable
- Enclosing class:
- SMSDataCodingScheme
public static final class SMSDataCodingScheme.MessageCodingScheme extends AbstractLazyEncodedNamedInteger<SMSDataCodingScheme.MessageCodingScheme.EncodedValue>
Class MessageCodingScheme represents the Message Coding case of a TP_DCS field.The API offered by this class is as if the type were specified in ASN.1 as follows.
MessageCodingScheme ::= SEQUENCE { messageCoding MessageCoding, messageClass MessageClass }
The class takes care of encoding the field values into a NamedInteger and decoding field values from a NamedInteger, the encoded representation being as tabulated below.Data Encoding - based on 3GPP TS 23.038 V8.2.0 (2008-09) §4 pp8-10 7 6 5 4 3 2 1 0 Octet 0 0 0 0 0 0 Message coding Message class - See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SMSDataCodingScheme.MessageCodingScheme.EncodedValue
Representation of MessageCodingScheme values as NamedIntegers.static class
SMSDataCodingScheme.MessageCodingScheme.MessageCoding
Enumeration of Message Coding 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 MessageCodingScheme()
Constructs a new MessageCodingScheme object with no fields set.MessageCodingScheme(byte[] data)
Constructs a new MessageCodingScheme object from network-encoded data.MessageCodingScheme(byte[] data, int start, int len)
Constructs a new MessageCodingScheme object from part of network-encoded data.MessageCodingScheme(int arg)
Constructs a new MessageCodingScheme object from the given int, making it be read-only (immutable).MessageCodingScheme(SMSDataCodingScheme.MessageCodingScheme.MessageCoding messageCoding, SMSDataCodingScheme.MessageClass messageClass)
Constructs a new MessageCodingScheme object from given values for all fields.MessageCodingScheme(DataInput in)
Constructs a new MessageCodingScheme 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.SMSDataCodingScheme.MessageCodingScheme
clone()
Constructs a copy of this object and everything reachable from it.static SMSDataCodingScheme.MessageCodingScheme
copyOf(SMSDataCodingScheme.MessageCodingScheme 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.protected SMSDataCodingScheme.MessageCodingScheme.EncodedValue
fromValue(int value)
Converts an int to a NamedInteger.byte[]
getByteArrayForm()
Gets the byte array encoded form.SMSDataCodingScheme.MessageCodingScheme.EncodedValue
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.SMSDataCodingScheme.MessageClass
getMessageClass()
Gets the value of the message class.SMSDataCodingScheme.MessageCodingScheme.MessageCoding
getMessageCoding()
Gets the value of the message coding.boolean
hasMessageClass()
Tests whether the field MessageClass has a value.boolean
hasMessageCoding()
Tests whether the field MessageCoding has a value.SMSDataCodingScheme.MessageCodingScheme
setMessageClass(SMSDataCodingScheme.MessageClass value)
Sets the value of the message class.SMSDataCodingScheme.MessageCodingScheme
setMessageCoding(SMSDataCodingScheme.MessageCodingScheme.MessageCoding value)
Sets the value of the message coding.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by {@link #SMSDataCodingScheme.MessageCodingScheme(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
-
MessageCodingScheme
public MessageCodingScheme()
Constructs a new MessageCodingScheme object with no fields set.
-
MessageCodingScheme
public MessageCodingScheme(byte[] data)
Constructs a new MessageCodingScheme 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
-
MessageCodingScheme
public MessageCodingScheme(byte[] data, int start, int len)
Constructs a new MessageCodingScheme 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
-
MessageCodingScheme
public MessageCodingScheme(SMSDataCodingScheme.MessageCodingScheme.MessageCoding messageCoding, SMSDataCodingScheme.MessageClass messageClass)
Constructs a new MessageCodingScheme object from given values for all fields.- Parameters:
messageCoding
- the message codingmessageClass
- the message class
-
MessageCodingScheme
public MessageCodingScheme(int arg)
Constructs a new MessageCodingScheme object from the given int, making it be read-only (immutable).- Parameters:
arg
- int
-
MessageCodingScheme
public MessageCodingScheme(DataInput in) throws IOException
Constructs a new MessageCodingScheme 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 by {@link #SMSDataCodingScheme.MessageCodingScheme(DataInput)}.- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
hasMessageCoding
public boolean hasMessageCoding() throws DecodeException
Tests whether the field MessageCoding has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
hasMessageClass
public boolean hasMessageClass() throws DecodeException
Tests whether the field MessageClass 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 classAbstractLazyEncodedDataObject<SMSDataCodingScheme.MessageCodingScheme.EncodedValue>
- Throws:
EncodeException
- if any mandatory field is not present
-
getMessageCoding
public SMSDataCodingScheme.MessageCodingScheme.MessageCoding getMessageCoding() throws DecodeException
Gets the value of the message coding.- Returns:
- MessageCoding representation of the message coding
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getMessageClass
public SMSDataCodingScheme.MessageClass getMessageClass() throws DecodeException
Gets the value of the message class.- Returns:
- MessageClass representation of the message class
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setMessageCoding
public SMSDataCodingScheme.MessageCodingScheme setMessageCoding(SMSDataCodingScheme.MessageCodingScheme.MessageCoding value) throws IllegalStateException
Sets the value of the message coding.- Parameters:
value
- MessageCoding representation of the message coding- Returns:
- this
- Throws:
IllegalStateException
-
setMessageClass
public SMSDataCodingScheme.MessageCodingScheme setMessageClass(SMSDataCodingScheme.MessageClass value) throws IllegalStateException
Sets the value of the message class.- Parameters:
value
- MessageClass representation of the message class- Returns:
- this
- Throws:
IllegalStateException
-
copyOf
public static SMSDataCodingScheme.MessageCodingScheme copyOf(SMSDataCodingScheme.MessageCodingScheme 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:
- MessageCodingScheme
-
clone
public SMSDataCodingScheme.MessageCodingScheme 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 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 classAbstractFieldsObject
- 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 SMSDataCodingScheme.MessageCodingScheme.EncodedValue getEncodedForm() throws EncodeException
Gets the encoded form.- Returns:
- encoded form
- Throws:
EncodeException
- if encoding fails
-
getByteArrayForm
public byte[] getByteArrayForm() throws EncodeException
Gets the byte array encoded form. The size of the array is the least of 1, 2, 4, or 8 according to the type's bounds. The most significant byte of the numeric value is in the lowest indexed byte of the array.- Returns:
- byte array form
- Throws:
EncodeException
- if encoding fails
-
fromValue
protected SMSDataCodingScheme.MessageCodingScheme.EncodedValue fromValue(int value)
Converts an int to a NamedInteger. Reuses any existing instance where possible.- Specified by:
fromValue
in classAbstractLazyEncodedNamedInteger<SMSDataCodingScheme.MessageCodingScheme.EncodedValue>
- Parameters:
value
- int- Returns:
- NamedInteger
-
encode
protected void encode()
Computes the encoded form from the decoded form.- Specified by:
encode
in classAbstractLazyEncodedDataObject<SMSDataCodingScheme.MessageCodingScheme.EncodedValue>
-
decode
protected void decode()
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<SMSDataCodingScheme.MessageCodingScheme.EncodedValue>
-
-