com.opencloud.slee.resources.cgin

Class EncodedStringWithIndicators

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

AbstractEncodedDataObject<T>

AbstractLazyEncodedDataObject<byte[]>

AbstractLazyEncodedByteArray

EncodedStringWithIndicators

All Implemented Interfaces:

DataObject, FastSerializable, Serializable

public final class EncodedStringWithIndicators
extends AbstractLazyEncodedByteArray
implements FastSerializable

Class EncodedStringWithIndicators represents the encoded form of a string field.

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

 EncodedStringWithIndicators ::= SEQUENCE {
     data       OCTET STRING,
     indicators StringIndicators
 }

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 - made up by OpenCloud
	8	7	6	5	4	3	2	1
Octet 0	Indicators
Octet 1
Octets 2..	Data

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

Method Summary

Methods

Modifier and Type	Method and Description
void	checkFieldsSet() Checks that all mandatory fields are present.
EncodedStringWithIndicators	clone() Constructs a copy of this object and everything reachable from it.
static EncodedStringWithIndicators	copyOf(EncodedStringWithIndicators 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[]	getData() Gets the value of the encoded octet string.
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.
StringIndicators	getIndicators() Gets the value of the indicators.
boolean	hasData() Tests whether the field Data has a value.
boolean	hasIndicators() Tests whether the field Indicators has a value.
EncodedStringWithIndicators	setData(byte[] value) Sets the value of the encoded octet string.
EncodedStringWithIndicators	setIndicators(StringIndicators value) Sets the value of the indicators.
void	toStream(DataOutput out) Serializes this object to a stream in a form suitable for reading by EncodedStringWithIndicators(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

EncodedStringWithIndicators

public EncodedStringWithIndicators()

Constructs a new EncodedStringWithIndicators object with no fields set.

EncodedStringWithIndicators

public EncodedStringWithIndicators(byte[] data)

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

EncodedStringWithIndicators

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

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

EncodedStringWithIndicators

public EncodedStringWithIndicators(byte[] data,
                           StringIndicators indicators)

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

Parameters:

data - the encoded octet string

indicators - the indicators

EncodedStringWithIndicators

public EncodedStringWithIndicators(DataInput in)
                            throws IOException

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

Specified by:

toStream in interface FastSerializable

Parameters:

out - the stream to write to

Throws:

IOException - if an I/O error occurs

hasData

public boolean hasData()
                throws DecodeException

Tests whether the field Data has a value.

Returns:

whether the field has a value

Throws:

DecodeException - if encoded state cannot be decoded

hasIndicators

public boolean hasIndicators()
                      throws DecodeException

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

getData

public byte[] getData()
               throws DecodeException

Gets the value of the encoded octet string.

Returns:

byte[] representation of the encoded octet string

Throws:

DecodeException - if encoded state cannot be decoded

getIndicators

public StringIndicators getIndicators()
                               throws DecodeException

Gets the value of the indicators.

Returns:

StringIndicators representation of the indicators

Throws:

DecodeException - if encoded state cannot be decoded

setData

public EncodedStringWithIndicators setData(byte[] value)
                                    throws IllegalStateException

Sets the value of the encoded octet string.

Parameters:

value - byte[] representation of the encoded octet string

Returns:

this

Throws:

IllegalStateException

setIndicators

public EncodedStringWithIndicators setIndicators(StringIndicators value)
                                          throws IllegalStateException

Sets the value of the indicators.

Parameters:

value - StringIndicators representation of the indicators

Returns:

this

Throws:

IllegalStateException

copyOf

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

EncodedStringWithIndicators

clone

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

encode

protected void encode()

Computes the encoded form from the decoded form.

Specified by:

encode in class AbstractLazyEncodedDataObject<byte[]>

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 2 octets to be decoded