Class SMSSubmit.ValidityPeriod
- 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
-
- All Implemented Interfaces:
DataObject
,Serializable
- Enclosing class:
- SMSSubmit
public static final class SMSSubmit.ValidityPeriod extends AbstractLazyEncodedByteArray
Representation of a ValidityPeriod. Contains data to be incorporated into a SMSSubmit message; 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.
ValidityPeriod ::= CHOICE { length INTEGER, timeStamp SMSTimeStamp, enhancedValidityPeriod EnhancedValidityPeriod }
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 pp68-69 7 6 5 4 3 2 1 0 1 octet 0 0 0 Validity period format discriminates... 0 0 0 Either 1 octet Length or 7 octets Time stamp or 7 octets Enhanced validity period
The 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SMSSubmit.ValidityPeriod.Choice
Enumeration of discriminating values.static class
SMSSubmit.ValidityPeriod.EnhancedValidityPeriod
Representation of an EnhancedValidityPeriod.
-
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 ValidityPeriod()
Constructs a new ValidityPeriod object with no fields set.ValidityPeriod(byte[] data)
Constructs a new ValidityPeriod object from network-encoded data.ValidityPeriod(byte[] data, int start, int len)
Constructs a new ValidityPeriod object from part of network-encoded data.ValidityPeriod(int length)
Constructs a new ValidityPeriod object from the given arguments.ValidityPeriod(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod enhancedValidityPeriod)
Constructs a new ValidityPeriod object from the given arguments.ValidityPeriod(SMSTimeStamp timeStamp)
Constructs a new ValidityPeriod object from the given arguments.ValidityPeriod(DataInput in)
Constructs a new ValidityPeriod 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.SMSSubmit.ValidityPeriod
clone()
Constructs a copy of this object and everything reachable from it.static SMSSubmit.ValidityPeriod
copyOf(SMSSubmit.ValidityPeriod 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.SMSSubmit.ValidityPeriod.Choice
getChoice()
Gets the discriminant for which choice is chosen.static int
getContainedLength(byte[] data, int start, int len)
Determines the length of the encoded value that commences at offsetstart
in the givendata
.byte[]
getEncodedForm()
Gets the encoded form.SMSSubmit.ValidityPeriod.EnhancedValidityPeriod
getEnhancedValidityPeriod()
Gets the value of enhanced format of validity period.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 :discriminant-name to field-value.int
getLength()
Gets the value of length of relative validity period.SMSTimeStamp
getTimeStamp()
Gets the value of absolute time of validity period termination.boolean
isEnhancedValidityPeriodChosen()
Tests whether the choice is enhancedValidityPeriod.boolean
isLengthChosen()
Tests whether the choice is length.boolean
isTimeStampChosen()
Tests whether the choice is timeStamp.SMSSubmit.ValidityPeriod
setEnhancedValidityPeriod(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod value)
Sets the value of enhanced format of validity period.SMSSubmit.ValidityPeriod
setLength(int value)
Sets the value of length of relative validity period.void
setReadOnly()
Sets this and all its fields to be immutable.SMSSubmit.ValidityPeriod
setTimeStamp(SMSTimeStamp value)
Sets the value of absolute time of validity period termination.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by {@link #SMSSubmit.ValidityPeriod(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
-
-
-
-
Constructor Detail
-
ValidityPeriod
public ValidityPeriod()
Constructs a new ValidityPeriod object with no fields set.
-
ValidityPeriod
public ValidityPeriod(byte[] data)
Constructs a new ValidityPeriod 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
-
ValidityPeriod
public ValidityPeriod(byte[] data, int start, int len)
Constructs a new ValidityPeriod 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
-
ValidityPeriod
public ValidityPeriod(DataInput in) throws IOException
Constructs a new ValidityPeriod 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
-
ValidityPeriod
public ValidityPeriod(int length)
Constructs a new ValidityPeriod object from the given arguments.- Parameters:
length
- length of relative validity period
-
ValidityPeriod
public ValidityPeriod(SMSTimeStamp timeStamp)
Constructs a new ValidityPeriod object from the given arguments.- Parameters:
timeStamp
- absolute time of validity period termination
-
ValidityPeriod
public ValidityPeriod(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod enhancedValidityPeriod)
Constructs a new ValidityPeriod object from the given arguments.- Parameters:
enhancedValidityPeriod
- EnhancedValidityPeriod of 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 {@link #SMSSubmit.ValidityPeriod(DataInput)}.- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
getChoice
public SMSSubmit.ValidityPeriod.Choice getChoice() throws DecodeException
Gets the discriminant for which choice is chosen.- Returns:
- enumerated constant
- Throws:
DecodeException
- if encoded state cannot be decoded
-
isLengthChosen
public boolean isLengthChosen() throws DecodeException
Tests whether the choice is length.- Returns:
- true if chosen, false if not
- Throws:
DecodeException
- if encoded state cannot be decoded
-
isTimeStampChosen
public boolean isTimeStampChosen() throws DecodeException
Tests whether the choice is timeStamp.- Returns:
- true if chosen, false if not
- Throws:
DecodeException
- if encoded state cannot be decoded
-
isEnhancedValidityPeriodChosen
public boolean isEnhancedValidityPeriodChosen() throws DecodeException
Tests whether the choice is enhancedValidityPeriod.- Returns:
- true if chosen, false if not
- 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<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, if choice is length of relative validity period
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getTimeStamp
public SMSTimeStamp getTimeStamp() throws DecodeException
Gets the value of absolute time of validity period termination.- Returns:
- SMSTimeStamp representation of absolute time of validity period termination, if choice is absolute time of validity period termination, else null
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getEnhancedValidityPeriod
public SMSSubmit.ValidityPeriod.EnhancedValidityPeriod getEnhancedValidityPeriod() throws DecodeException
Gets the value of enhanced format of validity period.- Returns:
- EnhancedValidityPeriod representation of enhanced format of validity period, if choice is enhanced format of validity period, else null
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setLength
public SMSSubmit.ValidityPeriod 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
-
setTimeStamp
public SMSSubmit.ValidityPeriod setTimeStamp(SMSTimeStamp value) throws IllegalStateException
Sets the value of absolute time of validity period termination.- Parameters:
value
- SMSTimeStamp representation of absolute time of validity period termination- Returns:
- this
- Throws:
IllegalStateException
-
setEnhancedValidityPeriod
public SMSSubmit.ValidityPeriod setEnhancedValidityPeriod(SMSSubmit.ValidityPeriod.EnhancedValidityPeriod value) throws IllegalStateException
Sets the value of enhanced format of validity period.- Parameters:
value
- EnhancedValidityPeriod representation of enhanced format of validity period- Returns:
- this
- Throws:
IllegalStateException
-
copyOf
public static SMSSubmit.ValidityPeriod copyOf(SMSSubmit.ValidityPeriod 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:
- ValidityPeriod
-
clone
public SMSSubmit.ValidityPeriod 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
-
setReadOnly
public void setReadOnly()
Sets this and all its fields to be immutable.- Specified by:
setReadOnly
in interfaceDataObject
- Overrides:
setReadOnly
in classAbstractDataObject
-
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 :discriminant-name to field-value. If choice is not set, returns a Map from : to AbstractFieldsObject.FIELD_UNINITIALISED. For a field of primitive type, the field-value is boxed. 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
- the value of this parameter is ignored- Returns:
- Map from :discriminant-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 offsetstart
in the givendata
. The value is not fully decoded and might not be decodable. If the encoded value ends with a filling field, then the givenlen
is returned. If the encoded value is so currupt that its length cannot be determined, then0
is returned.- Parameters:
data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be considered- Returns:
- length of encoded value, or 0 if not decodable
- Throws:
NullPointerException
- if data is null
-
encode
protected void encode() throws EncodeException
Computes the encoded form from the decoded form.- Specified by:
encode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if encoding fails
-
decode
protected void decode() throws DecodeException
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if decoding fails
-
-