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

Class SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

com.opencloud.slee.resources.in.datatypes.sms.SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

SMSSubmit.ValidityPeriod

public static final class SMSSubmit.ValidityPeriod.EnhancedValidityPeriod
extends AbstractLazyEncodedByteArray

Representation of an EnhancedValidityPeriod. Contains data to be incorporated into a SMSSubmit.ValidityPeriod; it does not get transmitted on a network as is.

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

 EnhancedValidityPeriod ::= SEQUENCE {
     singleShotSM     BOOLEAN,
     enhancedDuration EnhancedDuration
 }

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 23.040 V9.0.0 (2009-06) §9.2.3.12.3 pp68-69
		7	6	5	4	3	2	1	0
1 octet		ext	Single shot SM?	Reserved (0)			Enhanced validity period format discriminates...
Either	1 octet	Length
	5 octets	Spare (0)
or	1 octet	Seconds
	5 octets	Spare (0)
or	1 octet	Hours units				Hours tens
	1 octet	Minutes units				Minutes tens
	1 octet	Seconds units				Seconds tens
	3 octets	Spare (0)

The Enhanced Validity Period Format is a discriminant for how the following octets are decoded. This discriminant and the alternatives are encoded from and decoded to a value of a separate CHOICE-like nested type called EnhancedDuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration Representation of an EnhancedDuration.

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
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod() Constructs a new EnhancedValidityPeriod object with no fields set.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(boolean singleShotSM) Constructs a new EnhancedValidityPeriod object from the given arguments.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(boolean singleShotSM, SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration enhancedDuration) Constructs a new EnhancedValidityPeriod object from given values for all fields.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(byte[] data) Constructs a new EnhancedValidityPeriod object from network-encoded data.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(byte[] data, int start, int len) Constructs a new EnhancedValidityPeriod object from part of network-encoded data.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(DataInput in) Constructs a new EnhancedValidityPeriod 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.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod	clone() Constructs a copy of this object and everything reachable from it.
static SMSSubmit.ValidityPeriod.EnhancedValidityPeriod	copyOf(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod 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.
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.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	getEnhancedDuration() Gets the value of the enhanced duration.
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.
boolean	getSingleShotSM() Gets the value of whether the SC is required to make up to one delivery attempt.
boolean	hasEnhancedDuration() Tests whether the field EnhancedDuration has a value.
boolean	hasSingleShotSM() Tests whether the field SingleShotSM has a value.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod	setEnhancedDuration(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration value) Sets the value of the enhanced duration.
void	setReadOnly() Sets this and all its fields to be immutable.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod	setSingleShotSM(boolean value) Sets the value of whether the SC is required to make up to one delivery attempt.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod	setSingleShotSMPresent(boolean flag) Sets the presence or absence of the field SingleShotSM.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod()

Constructs a new EnhancedValidityPeriod object with no fields set.

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(byte[] data)

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

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(byte[] data,
                                               int start,
                                               int len)

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

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(boolean singleShotSM,
                                               SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration enhancedDuration)

Constructs a new EnhancedValidityPeriod object from given values for all fields.

Parameters:

singleShotSM - whether the SC is required to make up to one delivery attempt

enhancedDuration - the enhanced duration

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(DataInput in)
                                                throws IOException

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

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(boolean singleShotSM)

Constructs a new EnhancedValidityPeriod object from the given arguments.

Parameters:

singleShotSM - whether to make up to one delivery attempt

Method Detail

toStream

public void toStream(DataOutput out)
              throws IOException

Serializes this object to a stream in a form suitable for reading by SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(DataInput).

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasSingleShotSM

public boolean hasSingleShotSM()
                        throws DecodeException

Tests whether the field SingleShotSM has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setSingleShotSMPresent

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod setSingleShotSMPresent(boolean flag)
                                                                       throws IllegalStateException

Sets the presence or absence of the field SingleShotSM.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

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

hasEnhancedDuration

public boolean hasEnhancedDuration()
                            throws DecodeException

Tests whether the field EnhancedDuration 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<byte[]>

Throws:

EncodeException - if any mandatory field is not present

getSingleShotSM

public boolean getSingleShotSM()
                        throws DecodeException

Gets the value of whether the SC is required to make up to one delivery attempt.

Returns:

boolean representation of whether the SC is required to make up to one delivery attempt

Throws:

DecodeException - if encoded state cannot be decoded

getEnhancedDuration

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration getEnhancedDuration()
                                                                                     throws DecodeException

Gets the value of the enhanced duration.

Returns:

EnhancedDuration representation of the enhanced duration

Throws:

DecodeException - if encoded state cannot be decoded

setSingleShotSM

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod setSingleShotSM(boolean value)
                                                                throws IllegalStateException

Sets the value of whether the SC is required to make up to one delivery attempt.

Parameters:

value - boolean representation of whether the SC is required to make up to one delivery attempt

Returns:

this

Throws:

IllegalStateException

setEnhancedDuration

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod setEnhancedDuration(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration value)
                                                                    throws IllegalStateException

Sets the value of the enhanced duration.

Parameters:

value - EnhancedDuration representation of the enhanced duration

Returns:

this

Throws:

IllegalStateException

copyOf

public static SMSSubmit.ValidityPeriod.EnhancedValidityPeriod copyOf(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod 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:

EnhancedValidityPeriod

clone

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod 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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

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 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. Values of this type are of a fixed length, so that length is returned if the data is long enough, otherwise 0 is returned.

Parameters:

data - network-encoded data

start - index into data where value commences

len - length in data to be considered

Returns:

7, 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 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 decoding fails