public static final class SMSSubmit.ValidityPeriod.EnhancedValidityPeriod extends AbstractLazyEncodedByteArray
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) |
Modifier and Type | Class and Description |
---|---|
static class |
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration
Representation of an EnhancedDuration.
|
isDecoded
encoded
FIELD_ABSENT, FIELD_UNINITIALISED
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) . |
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) . |
checkDecode, checkModifyAndDecode
equals, hashCode, toString
checkModify, isReadOnly
public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod()
public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(byte[] data)
data
- network-encoded dataNullPointerException
- if data is nullpublic SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(byte[] data, int start, int len)
start
and is len
bytes long.
The data is not decoded and might not be decodable.data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictableNullPointerException
- if data is nullIllegalArgumentException
- if len is negativepublic SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(boolean singleShotSM, SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration enhancedDuration)
singleShotSM
- whether the SC is required to make up to one delivery attemptenhancedDuration
- the enhanced durationpublic SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(DataInput in) throws IOException
toStream(DataOutput)
.in
- the stream to read fromEOFException
- if reading is pre-empted by end-of-fileIOException
- if the data cannot be readpublic SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(boolean singleShotSM)
singleShotSM
- whether to make up to one delivery attemptpublic void toStream(DataOutput out) throws IOException
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod(DataInput)
.out
- the stream to write toIOException
- if an I/O error occurspublic boolean hasSingleShotSM() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic SMSSubmit.ValidityPeriod.EnhancedValidityPeriod setSingleShotSMPresent(boolean flag) throws IllegalStateException
flag
- whether the field should be marked as presentIllegalStateException
- if this instance has been marked as read-onlypublic boolean hasEnhancedDuration() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic void checkFieldsSet() throws EncodeException
checkFieldsSet
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if any mandatory field is not presentpublic boolean getSingleShotSM() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration getEnhancedDuration() throws DecodeException
DecodeException
- if encoded state cannot be decodedpublic SMSSubmit.ValidityPeriod.EnhancedValidityPeriod setSingleShotSM(boolean value) throws IllegalStateException
value
- boolean representation of whether the SC is required to make up to one delivery attemptIllegalStateException
public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod setEnhancedDuration(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod.EnhancedDuration value) throws IllegalStateException
value
- EnhancedDuration representation of the enhanced durationIllegalStateException
public static SMSSubmit.ValidityPeriod.EnhancedValidityPeriod copyOf(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod from)
from
- the object from which to copypublic SMSSubmit.ValidityPeriod.EnhancedValidityPeriod clone()
clone
in interface DataObject
clone
in class AbstractDataObject
public void setReadOnly()
setReadOnly
in interface DataObject
setReadOnly
in class AbstractDataObject
public static FieldAccessor[] getFieldAccessors()
public Map<String,Object> getFieldsMap(boolean withAbsents)
getFieldsMap
in class AbstractFieldsObject
withAbsents
- whether to put absent optional fields into Mapprotected boolean encodedIsInvalid()
public byte[] getEncodedForm() throws EncodeException
EncodeException
- if encoding failspublic static int getContainedLength(byte[] data, int start, int len)
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.data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be consideredprotected void encode() throws EncodeException
encode
in class AbstractLazyEncodedDataObject<byte[]>
EncodeException
- if encoding failsprotected void decode() throws DecodeException
decode
in class AbstractLazyEncodedDataObject<byte[]>
DecodeException
- if decoding fails