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

Class SMSDataCodingScheme.GeneralScheme

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<T>

AbstractLazyEncodedNamedInteger<SMSDataCodingScheme.GeneralScheme.EncodedValue>

com.opencloud.slee.resources.in.datatypes.sms.SMSDataCodingScheme.GeneralScheme

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

SMSDataCodingScheme

public static final class SMSDataCodingScheme.GeneralScheme
extends AbstractLazyEncodedNamedInteger<SMSDataCodingScheme.GeneralScheme.EncodedValue>

Class GeneralScheme represents the General Data and Auto Delete cases of a TP-DCS field.

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

 GeneralScheme ::= SEQUENCE {
     compressed   BOOLEAN,
     characterSet CharacterSet,
     messageClass MessageClass OPTIONAL
 }

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	Compressed?	Has message class?	Character set		Message class

Field names ending in ? are booleans: 1 for true, 0 for false.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SMSDataCodingScheme.GeneralScheme.CharacterSet	Enumeration of Character Set constants.
static class	SMSDataCodingScheme.GeneralScheme.EncodedValue	Representation of GeneralScheme values as NamedIntegers.

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
GeneralScheme()	Constructs a new GeneralScheme object with no fields set.
GeneralScheme(byte[] data)	Constructs a new GeneralScheme object from network-encoded data.
GeneralScheme(byte[] data, int start, int len)	Constructs a new GeneralScheme object from part of network-encoded data.
GeneralScheme(DataInput in)	Constructs a new GeneralScheme 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.
SMSDataCodingScheme.GeneralScheme	clone()	Constructs a copy of this object and everything reachable from it.
static SMSDataCodingScheme.GeneralScheme	copyOf(SMSDataCodingScheme.GeneralScheme 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.GeneralScheme.EncodedValue	fromValue(int value)	Converts an int to a NamedInteger.
byte[]	getByteArrayForm()	Gets the byte array encoded form.
SMSDataCodingScheme.GeneralScheme.CharacterSet	getCharacterSet()	Gets the value of the character set.
boolean	getCompressed()	Gets the value of whether the text is compressed.
SMSDataCodingScheme.GeneralScheme.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.
boolean	hasCharacterSet()	Tests whether the field CharacterSet has a value.
boolean	hasCompressed()	Tests whether the field Compressed has a value.
boolean	hasMessageClass()	Tests whether the field MessageClass has a value.
SMSDataCodingScheme.GeneralScheme	setCharacterSet(SMSDataCodingScheme.GeneralScheme.CharacterSet value)	Sets the value of the character set.
SMSDataCodingScheme.GeneralScheme	setCompressed(boolean value)	Sets the value of whether the text is compressed.
SMSDataCodingScheme.GeneralScheme	setCompressedPresent(boolean flag)	Sets the presence or absence of the field Compressed.
SMSDataCodingScheme.GeneralScheme	setMessageClass(SMSDataCodingScheme.MessageClass value)	Sets the value of the message class.
void	toStream(DataOutput out)	Serializes this object to a stream in a form suitable for reading by {@link #SMSDataCodingScheme.GeneralScheme(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

GeneralScheme

public GeneralScheme()

Constructs a new GeneralScheme object with no fields set.

GeneralScheme

public GeneralScheme(byte[] data)

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

GeneralScheme

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

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

GeneralScheme

public GeneralScheme(DataInput in)
              throws IOException

Constructs a new GeneralScheme 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 #SMSDataCodingScheme.GeneralScheme(DataInput)}.

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasCompressed

public boolean hasCompressed()
                      throws DecodeException

Tests whether the field Compressed has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setCompressedPresent

public SMSDataCodingScheme.GeneralScheme setCompressedPresent(boolean flag)
                                                       throws IllegalStateException

Sets the presence or absence of the field Compressed.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

hasCharacterSet

public boolean hasCharacterSet()
                        throws DecodeException

Tests whether the field CharacterSet 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 class AbstractLazyEncodedDataObject<SMSDataCodingScheme.GeneralScheme.EncodedValue>

Throws:

EncodeException - if any mandatory field is not present

getCompressed

public boolean getCompressed()
                      throws DecodeException

Gets the value of whether the text is compressed.

Returns:

boolean representation of whether the text is compressed

Throws:

DecodeException - if encoded state cannot be decoded

getCharacterSet

public SMSDataCodingScheme.GeneralScheme.CharacterSet getCharacterSet()
                                                               throws DecodeException

Gets the value of the character set.

Returns:

CharacterSet representation of the character set

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

setCompressed

public SMSDataCodingScheme.GeneralScheme setCompressed(boolean value)
                                                throws IllegalStateException

Sets the value of whether the text is compressed.

Parameters:

value - boolean representation of whether the text is compressed

Returns:

this

Throws:

IllegalStateException

setCharacterSet

public SMSDataCodingScheme.GeneralScheme setCharacterSet(SMSDataCodingScheme.GeneralScheme.CharacterSet value)
                                                  throws IllegalStateException

Sets the value of the character set.

Parameters:

value - CharacterSet representation of the character set

Returns:

this

Throws:

IllegalStateException

setMessageClass

public SMSDataCodingScheme.GeneralScheme 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.GeneralScheme copyOf(SMSDataCodingScheme.GeneralScheme 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:

GeneralScheme

clone

public SMSDataCodingScheme.GeneralScheme 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 SMSDataCodingScheme.GeneralScheme.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.GeneralScheme.EncodedValue fromValue(int value)

Converts an int to a NamedInteger. Reuses any existing instance where possible.

Specified by:

fromValue in class AbstractLazyEncodedNamedInteger<SMSDataCodingScheme.GeneralScheme.EncodedValue>

Parameters:

value - int

Returns:

NamedInteger

encode

protected void encode()

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<SMSDataCodingScheme.GeneralScheme.EncodedValue>

Throws:

EncodeException - if address cannot be encoded

decode

protected void decode()

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<SMSDataCodingScheme.GeneralScheme.EncodedValue>