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

Class AddressDelimiter

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

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

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class AddressDelimiter
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class AddressDelimiter represents the startDigit, endOfReplyDigit and cancelDigit fields of CollectedInformation. These fields are one or two digits long.

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

 AddressDelimiter ::= SEQUENCE {
     delimiter DigitString
 }

The class takes care of encoding the field value into a byte-array and decoding the field value from a byte-array, the encoded representation being as tabulated below.

Data Encoding - based on comment in ASN.1 module CAP-datatypes and S5MPP spec
	8	7	6	5	4	3	2	1
Octet 0	0	0	0	0	Delimiter digit 1
Octet 1*	0	0	0	0	Delimiter digit 2

Octet 1* is present only if there is a 2nd digit. Each digit of the delimiter field is encoded into a semi-octet, using only the least significant semi-octets. Unless overridden by a particular StringCodec, the encoding to semi-octets is as tabulated below.

Decoded character	0	1	2	3	4	5	6	7	8	9		*	#
Encoded hexadecimal	0	1	2	3	4	5	6	7	8	9	A	B	C	D	E	F

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static BCDStringCodec<AddressDelimiter>	DELIMITER_CODEC BCD string codec for field Delimiter.

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
AddressDelimiter() Constructs a new AddressDelimiter object with no fields set.
AddressDelimiter(byte[] data) Constructs a new AddressDelimiter object from network-encoded data.
AddressDelimiter(byte[] data, int start, int len) Constructs a new AddressDelimiter object from part of network-encoded data.
AddressDelimiter(DataInput in) Constructs a new AddressDelimiter object from data deserialized from a stream that was written by toStream(DataOutput).
AddressDelimiter(String delimiter) Constructs a new AddressDelimiter object from given values for all fields.
AddressDelimiter(String delimiter, StringCodec<AddressDelimiter> Delimiter_codec) Constructs a new AddressDelimiter object from given arguments, using the given codecs for encoding fields of type String.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
AddressDelimiter	clone() Constructs a copy of this object and everything reachable from it.
static AddressDelimiter	copyOf(AddressDelimiter 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.
String	getDelimiter() Gets the value of the digits.
String	getDelimiter(StringCodec<AddressDelimiter> codec) Gets the value of the digits using the given codec.
StringCodec<AddressDelimiter>	getDelimiterCodec() Gets the codec used for field Delimiter.
byte[]	getDelimiterEncoded() Gets a clone of the encoded value of the digits.
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.
boolean	hasDelimiter() Tests whether the field Delimiter has a value.
AddressDelimiter	setDelimiter(String value) Sets the value of the digits.
AddressDelimiter	setDelimiter(String value, StringCodec<AddressDelimiter> codec) Sets the value of the digits using the given codec.
AddressDelimiter	setDelimiterEncoded(byte[] encoded) Sets the encoded value of the digits to a clone of the given byte array.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by AddressDelimiter(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

Field Detail

DELIMITER_CODEC

public static final BCDStringCodec<AddressDelimiter> DELIMITER_CODEC

BCD string codec for field Delimiter.

Constructor Detail

AddressDelimiter

public AddressDelimiter()

Constructs a new AddressDelimiter object with no fields set.

AddressDelimiter

public AddressDelimiter(byte[] data)

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

AddressDelimiter

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

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

AddressDelimiter

public AddressDelimiter(String delimiter)

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

Parameters:

delimiter - the digits

AddressDelimiter

public AddressDelimiter(String delimiter,
                StringCodec<AddressDelimiter> Delimiter_codec)

Constructs a new AddressDelimiter object from given arguments, using the given codecs for encoding fields of type String.

Parameters:

delimiter - the digits

Delimiter_codec - StringCodec for delimiter

AddressDelimiter

public AddressDelimiter(DataInput in)
                 throws IOException

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

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasDelimiter

public boolean hasDelimiter()
                     throws DecodeException

Tests whether the field Delimiter 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

getDelimiter

public String getDelimiter()
                    throws DecodeException

Gets the value of the digits. Equivalent to getDelimiter(null).

Returns:

String representation of the digits

Throws:

DecodeException - if encoded state cannot be decoded

setDelimiter

public AddressDelimiter setDelimiter(String value)
                              throws IllegalStateException

Sets the value of the digits.

Parameters:

value - String representation of the digits

Returns:

this

Throws:

IllegalStateException

getDelimiter

public String getDelimiter(StringCodec<AddressDelimiter> codec)
                    throws DecodeException

Gets the value of the digits using the given codec. If the field Delimiter is not set, returns null. If the given codec is null, then uses the standard codec for this field.

Parameters:

codec - StringCodec to use for decoding

Returns:

String representation of the digits

Throws:

DecodeException - if encoded state cannot be decoded

getDelimiterEncoded

public byte[] getDelimiterEncoded()

Gets a clone of the encoded value of the digits.

Returns:

byte[] representation of the digits

setDelimiter

public AddressDelimiter setDelimiter(String value,
                            StringCodec<AddressDelimiter> codec)
                              throws IllegalArgumentException

Sets the value of the digits using the given codec. If the given codec is null, uses the standard codec.

Parameters:

value - String representation of the digits

codec - StringCodec to use for encoding

Returns:

this

Throws:

IllegalArgumentException

setDelimiterEncoded

public AddressDelimiter setDelimiterEncoded(byte[] encoded)

Sets the encoded value of the digits to a clone of the given byte array.

Parameters:

encoded - byte[] representation of the digits

Returns:

this

copyOf

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

AddressDelimiter

clone

public AddressDelimiter 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

getDelimiterCodec

public StringCodec<AddressDelimiter> getDelimiterCodec()

Gets the codec used for field Delimiter.

Returns:

StringCodec

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. If the encoded value ends with a filling field, then the given len is returned. If the encoded value is so currupt that its length cannot be determined, then 0 is returned.

Parameters:

data - network-encoded data

start - index into data where value commences

len - 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()

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

EncodeException - if Delimiter is not 1 or 2 digits

decode

protected void decode()
               throws DecodeException

Computes the decoded form from the encoded form.

Specified by:

decode in class AbstractLazyEncodedDataObject<byte[]>

Throws:

DecodeException - if not 1 or 2 octets to be decoded