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

Class SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration

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.EnhancedDuration

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod

public static final class SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration
extends AbstractLazyEncodedByteArray

Representation of an EnhancedDuration. Contains data to be incorporated into a SMSSubmit.ValidityPeriod.EnhancedValidityPeriod; 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.

 EnhancedDuration ::= SEQUENCE {
     length  INTEGER OPTIONAL,
     hours   INTEGER OPTIONAL,
     minutes INTEGER OPTIONAL,
     seconds INTEGER OPTIONAL
 }

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		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. On encoding, the discriminant is automatically set according to which alternative is encoded.

See Also:

Serialized Form

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.EnhancedDuration() Constructs a new EnhancedDuration object with no fields set.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration(byte[] data) Constructs a new EnhancedDuration object from network-encoded data.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration(byte[] data, int start, int len) Constructs a new EnhancedDuration object from part of network-encoded data.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration(DataInput in) Constructs a new EnhancedDuration object from data deserialized from a stream that was written by toStream(DataOutput).
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration(int length) Constructs a new EnhancedDuration object from the given arguments.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration(int hours, int minutes, int seconds) Constructs a new EnhancedDuration object from the given arguments.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	clone() Constructs a copy of this object and everything reachable from it.
static SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	copyOf(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration 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.
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.
int	getHours() Gets the value of hours part of relative validity period.
int	getLength() Gets the value of length of relative validity period.
int	getMinutes() Gets the value of minutes part of relative validity period.
int	getSeconds() Gets the value of seconds part or whole of relative validity period.
boolean	hasHours() Tests whether the field Hours has a value.
boolean	hasLength() Tests whether the field Length has a value.
boolean	hasMinutes() Tests whether the field Minutes has a value.
boolean	hasSeconds() Tests whether the field Seconds has a value.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	setHours(int value) Sets the value of hours part of relative validity period.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	setHoursPresent(boolean flag) Sets the presence or absence of the field Hours.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	setLength(int value) Sets the value of length of relative validity period.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	setLengthPresent(boolean flag) Sets the presence or absence of the field Length.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	setMinutes(int value) Sets the value of minutes part of relative validity period.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	setMinutesPresent(boolean flag) Sets the presence or absence of the field Minutes.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	setSeconds(int value) Sets the value of seconds part or whole of relative validity period.
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration	setSecondsPresent(boolean flag) Sets the presence or absence of the field Seconds.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration(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, setReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration()

Constructs a new EnhancedDuration object with no fields set.

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration

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

Constructs a new EnhancedDuration 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.EnhancedDuration

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

Constructs a new EnhancedDuration 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.EnhancedDuration

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

Constructs a new EnhancedDuration 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.EnhancedDuration

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration(int length)

Constructs a new EnhancedDuration object from the given arguments.

Parameters:

length - length of relative validity period

SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration(int hours,
                                                                int minutes,
                                                                int seconds)

Constructs a new EnhancedDuration object from the given arguments.

Parameters:

hours - hours part of relative validity period

minutes - minutes part of relative validity period

seconds - seconds part of relative validity period

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.EnhancedDuration(DataInput).

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasLength

public boolean hasLength()
                  throws DecodeException

Tests whether the field Length has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setLengthPresent

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration setLengthPresent(boolean flag)
                                                                                  throws IllegalStateException

Sets the presence or absence of the field Length.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

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

hasHours

public boolean hasHours()
                 throws DecodeException

Tests whether the field Hours has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setHoursPresent

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration setHoursPresent(boolean flag)
                                                                                 throws IllegalStateException

Sets the presence or absence of the field Hours.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

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

hasMinutes

public boolean hasMinutes()
                   throws DecodeException

Tests whether the field Minutes has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setMinutesPresent

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration setMinutesPresent(boolean flag)
                                                                                   throws IllegalStateException

Sets the presence or absence of the field Minutes.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

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

hasSeconds

public boolean hasSeconds()
                   throws DecodeException

Tests whether the field Seconds has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setSecondsPresent

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration setSecondsPresent(boolean flag)
                                                                                   throws IllegalStateException

Sets the presence or absence of the field Seconds.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

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

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

getLength

public int getLength()
              throws DecodeException

Gets the value of length of relative validity period.

Returns:

int representation of length of relative validity period

Throws:

DecodeException - if encoded state cannot be decoded

getHours

public int getHours()
             throws DecodeException

Gets the value of hours part of relative validity period.

Returns:

int representation of hours part of relative validity period

Throws:

DecodeException - if encoded state cannot be decoded

getMinutes

public int getMinutes()
               throws DecodeException

Gets the value of minutes part of relative validity period.

Returns:

int representation of minutes part of relative validity period

Throws:

DecodeException - if encoded state cannot be decoded

getSeconds

public int getSeconds()
               throws DecodeException

Gets the value of seconds part or whole of relative validity period.

Returns:

int representation of seconds part or whole of relative validity period

Throws:

DecodeException - if encoded state cannot be decoded

setLength

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration setLength(int value)
                                                                           throws IllegalStateException

Sets the value of length of relative validity period.

Parameters:

value - int representation of length of relative validity period

Returns:

this

Throws:

IllegalStateException

setHours

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration setHours(int value)
                                                                          throws IllegalStateException

Sets the value of hours part of relative validity period.

Parameters:

value - int representation of hours part of relative validity period

Returns:

this

Throws:

IllegalStateException

setMinutes

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration setMinutes(int value)
                                                                            throws IllegalStateException

Sets the value of minutes part of relative validity period.

Parameters:

value - int representation of minutes part of relative validity period

Returns:

this

Throws:

IllegalStateException

setSeconds

public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration setSeconds(int value)
                                                                            throws IllegalStateException

Sets the value of seconds part or whole of relative validity period.

Parameters:

value - int representation of seconds part or whole of relative validity period

Returns:

this

Throws:

IllegalStateException

copyOf

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

EnhancedDuration

clone

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