com.opencloud.slee.resources.in.datatypes.cc

Class YearMonthDay

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

com.opencloud.slee.resources.in.datatypes.cc.YearMonthDay

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class YearMonthDay
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class YearMonthDay represents a date.

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

 YearMonthDay ::= SEQUENCE {
     year   INTEGER,
     month  INTEGER,
     day    INTEGER
 }

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. The digits are encoded separately in BCD. An INAP date has only two digits in the year, whereas a CAP date has four digits in the year.

Data Encoding - based on comment in ASN.1 module Core-INAP-CS1-DataTypes
	8	7	6	5	4	3	2	1
Octet 0	Year units				Year tens
Octet 1	Month units				Month tens
Octet 2	Day units				Day tens

For example, 1993 September 30th is encoded as 399003 (assuming the high nibble is written before the low nibble).

Data Encoding - based on comment in ASN.1 module CAP-DataTypes
	8	7	6	5	4	3	2	1
Octet 0	Year hundreds				Year thousands
Octet 1	Year units				Year tens
Octet 2	Month units				Month tens
Octet 3	Day units				Day tens

For example, 1993 September 30th is encoded as 91399003 (assuming the high nibble is written before the low nibble).

Note that the INAP form does not store millennium or century information. When encoding to INAP, the millennium and century digits are ignored. When decoding from INAP, a millennium and century are selected so that the resulting year lies in the range [1970,2069]; if a different range is needed, then use the returned year modulo 100 to obtain the raw value.

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
YearMonthDay() Constructs a new YearMonthDay object with no fields set.
YearMonthDay(byte[] data) Constructs a new YearMonthDay object from network-encoded data.
YearMonthDay(byte[] data, int start, int len) Constructs a new YearMonthDay object from part of network-encoded data.
YearMonthDay(DataInput in) Constructs a new YearMonthDay object from data deserialized from a stream that was written by toStream(DataOutput).
YearMonthDay(int year, int month, int day) Constructs a new YearMonthDay object from given values for all fields.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
YearMonthDay	clone() Constructs a copy of this object and everything reachable from it.
static YearMonthDay	copyOf(YearMonthDay 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.
byte[]	getCapEncodedForm() Gets the CAP encoded form of this YearMonthDay instance.
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.
int	getDay() Gets the value of the day of the month, in range [1,31].
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.
byte[]	getInapEncodedForm() Gets the INAP encoded form of this YearMonthDay instance.
int	getMonth() Gets the value of the month, in range [1,12].
int	getYear() Gets the value of the year, in range [0,9999].
boolean	hasDay() Tests whether the field Day has a value.
boolean	hasMonth() Tests whether the field Month has a value.
boolean	hasYear() Tests whether the field Year has a value.
YearMonthDay	setDay(int value) Sets the value of the day of the month, in range [1,31].
YearMonthDay	setDayPresent(boolean flag) Sets the presence or absence of the field Day.
YearMonthDay	setMonth(int value) Sets the value of the month, in range [1,12].
YearMonthDay	setMonthPresent(boolean flag) Sets the presence or absence of the field Month.
YearMonthDay	setYear(int value) Sets the value of the year, in range [0,9999].
YearMonthDay	setYearPresent(boolean flag) Sets the presence or absence of the field Year.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by YearMonthDay(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

YearMonthDay

public YearMonthDay()

Constructs a new YearMonthDay object with no fields set.

YearMonthDay

public YearMonthDay(byte[] data)

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

YearMonthDay

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

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

YearMonthDay

public YearMonthDay(int year,
            int month,
            int day)

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

Parameters:

year - the year, in range [0,9999]

month - the month, in range [1,12]

day - the day of the month, in range [1,31]

YearMonthDay

public YearMonthDay(DataInput in)
             throws IOException

Constructs a new YearMonthDay 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 YearMonthDay(DataInput).

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasYear

public boolean hasYear()
                throws DecodeException

Tests whether the field Year has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setYearPresent

public YearMonthDay setYearPresent(boolean flag)
                            throws IllegalStateException

Sets the presence or absence of the field Year.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

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

hasMonth

public boolean hasMonth()
                 throws DecodeException

Tests whether the field Month has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setMonthPresent

public YearMonthDay setMonthPresent(boolean flag)
                             throws IllegalStateException

Sets the presence or absence of the field Month.

Parameters:

flag - whether the field should be marked as present

Returns:

this

Throws:

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

hasDay

public boolean hasDay()
               throws DecodeException

Tests whether the field Day has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

setDayPresent

public YearMonthDay setDayPresent(boolean flag)
                           throws IllegalStateException

Sets the presence or absence of the field Day.

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

getYear

public int getYear()
            throws DecodeException

Gets the value of the year, in range [0,9999].

Returns:

int representation of the year, in range [0,9999]

Throws:

DecodeException - if encoded state cannot be decoded

getMonth

public int getMonth()
             throws DecodeException

Gets the value of the month, in range [1,12].

Returns:

int representation of the month, in range [1,12]

Throws:

DecodeException - if encoded state cannot be decoded

getDay

public int getDay()
           throws DecodeException

Gets the value of the day of the month, in range [1,31].

Returns:

int representation of the day of the month, in range [1,31]

Throws:

DecodeException - if encoded state cannot be decoded

setYear

public YearMonthDay setYear(int value)
                     throws IllegalStateException

Sets the value of the year, in range [0,9999].

Parameters:

value - int representation of the year, in range [0,9999]

Returns:

this

Throws:

IllegalStateException

setMonth

public YearMonthDay setMonth(int value)
                      throws IllegalStateException

Sets the value of the month, in range [1,12].

Parameters:

value - int representation of the month, in range [1,12]

Returns:

this

Throws:

IllegalStateException

setDay

public YearMonthDay setDay(int value)
                    throws IllegalStateException

Sets the value of the day of the month, in range [1,31].

Parameters:

value - int representation of the day of the month, in range [1,31]

Returns:

this

Throws:

IllegalStateException

copyOf

public static YearMonthDay copyOf(YearMonthDay 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:

YearMonthDay

clone

public YearMonthDay 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 variable length, so the given 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:

len, or 0 if encoded value is not long enough

getInapEncodedForm

public byte[] getInapEncodedForm()

Gets the INAP encoded form of this YearMonthDay instance. The INAP encoded form is a BCD-encoded byte array of length 3 in the form YYMMDD.

Returns:

the INAP encoded form of this YearMonthDay instance

getCapEncodedForm

public byte[] getCapEncodedForm()

Gets the CAP encoded form of this YearMonthDay instance. The CAP encoded form is a BCD-encoded byte array of length 4 in the form YYYYMMDD.

Returns:

the CAP encoded form of this YearMonthDay instance

encode

protected void encode()
               throws EncodeException

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if Year is not in range [0,9999], or Month is not in range [1,12], or Day is not in range [1,31]

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if less than 3 or more than 4 octets to be decoded