com.opencloud.slee.resources.cgin

Class EncodedInteger

java.lang.Object

java.lang.Number

EncodedInteger

All Implemented Interfaces:

DataObject, Immutable, java.io.Serializable

public abstract class EncodedInteger
extends java.lang.Number
implements DataObject, Immutable

An integer that knows how to encode/decode itself to a simple network form.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncodedInteger.Codec Every EncodedInteger instance has an associated Codec instance that knows how to encode / decode / range-check integers of that type.
static class	EncodedInteger.GenericCodec A generic codec that can encode big- or little-endian values of variable width and signedness.

Field Summary

Fields

Modifier and Type	Field and Description
static EncodedInteger.Codec	S16BE A signed 16-bit integer encoded in 2 bytes, MSB-first
static EncodedInteger.Codec	S16LE A signed 16-bit integer encoded in 2 bytes, LSB-first
static EncodedInteger.Codec	S24BE A signed 24-bit integer encoded in 3 bytes, MSB-first
static EncodedInteger.Codec	S24LE A signed 24-bit integer encoded in 3 bytes, LSB-first
static EncodedInteger.Codec	S32BE A signed 32-bit integer encoded in 4 bytes, MSB-first
static EncodedInteger.Codec	S32LE A signed 32-bit integer encoded in 4 bytes, LSB-first
static EncodedInteger.Codec	S8 A signed 8-bit integer encoded in 1 byte
static EncodedInteger.Codec	U16BE An unsigned 16-bit integer encoded in 2 bytes, MSB-first
static EncodedInteger.Codec	U16LE An unsigned 16-bit integer encoded in 2 bytes, LSB-first
static EncodedInteger.Codec	U24BE An unsigned 24-bit integer encoded in 3 bytes, MSB-first
static EncodedInteger.Codec	U24LE An unsigned 24-bit integer encoded in 3 bytes, LSB-first
static EncodedInteger.Codec	U8 An unsigned 8-bit integer encoded in 1 byte

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EncodedInteger(EncodedInteger.Codec codec, byte[] data)
protected	EncodedInteger(EncodedInteger.Codec codec, byte[] data, int start, int len)
protected	EncodedInteger(EncodedInteger.Codec codec, java.io.DataInput input)
protected	EncodedInteger(EncodedInteger.Codec codec, int value)

Method Summary

Methods

Modifier and Type	Method and Description
byte	byteValue()
java.lang.Object	clone() Perform a deep copy of this object.
double	doubleValue()
boolean	equals(java.lang.Object o)
float	floatValue()
static EncodedInteger.Codec	getCodec(int min, int max, int width, boolean bigEndian, boolean signed)
byte[]	getEncodedForm()
int	hashCode()
int	intValue()
boolean	isReadOnly() Check if this object has been set read-only.
long	longValue()
void	setReadOnly() Set this object to be "read-only".
short	shortValue()
void	toStream(java.io.DataOutput out)
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

U8

public static final EncodedInteger.Codec U8

An unsigned 8-bit integer encoded in 1 byte

U16BE

public static final EncodedInteger.Codec U16BE

An unsigned 16-bit integer encoded in 2 bytes, MSB-first

U16LE

public static final EncodedInteger.Codec U16LE

An unsigned 16-bit integer encoded in 2 bytes, LSB-first

U24BE

public static final EncodedInteger.Codec U24BE

An unsigned 24-bit integer encoded in 3 bytes, MSB-first

U24LE

public static final EncodedInteger.Codec U24LE

An unsigned 24-bit integer encoded in 3 bytes, LSB-first

S8

public static final EncodedInteger.Codec S8

A signed 8-bit integer encoded in 1 byte

S16BE

public static final EncodedInteger.Codec S16BE

A signed 16-bit integer encoded in 2 bytes, MSB-first

S16LE

public static final EncodedInteger.Codec S16LE

A signed 16-bit integer encoded in 2 bytes, LSB-first

S24BE

public static final EncodedInteger.Codec S24BE

A signed 24-bit integer encoded in 3 bytes, MSB-first

S24LE

public static final EncodedInteger.Codec S24LE

A signed 24-bit integer encoded in 3 bytes, LSB-first

S32BE

public static final EncodedInteger.Codec S32BE

A signed 32-bit integer encoded in 4 bytes, MSB-first

S32LE

public static final EncodedInteger.Codec S32LE

A signed 32-bit integer encoded in 4 bytes, LSB-first

Constructor Detail

EncodedInteger

protected EncodedInteger(EncodedInteger.Codec codec,
              java.io.DataInput input)
                  throws java.io.IOException

Throws:

java.io.IOException

EncodedInteger

protected EncodedInteger(EncodedInteger.Codec codec,
              int value)
                  throws EncodeException

Throws:

EncodeException

EncodedInteger

protected EncodedInteger(EncodedInteger.Codec codec,
              byte[] data)

EncodedInteger

protected EncodedInteger(EncodedInteger.Codec codec,
              byte[] data,
              int start,
              int len)

Method Detail

getCodec

public static EncodedInteger.Codec getCodec(int min,
                            int max,
                            int width,
                            boolean bigEndian,
                            boolean signed)

getEncodedForm

public byte[] getEncodedForm()

toStream

public void toStream(java.io.DataOutput out)
              throws java.io.IOException

Throws:

java.io.IOException

byteValue

public final byte byteValue()

Overrides:

byteValue in class java.lang.Number

shortValue

public final short shortValue()

Overrides:

shortValue in class java.lang.Number

intValue

public final int intValue()

Specified by:

intValue in class java.lang.Number

longValue

public final long longValue()

Specified by:

longValue in class java.lang.Number

floatValue

public final float floatValue()

Specified by:

floatValue in class java.lang.Number

doubleValue

public final double doubleValue()

Specified by:

doubleValue in class java.lang.Number

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Description copied from interface: DataObject

Perform a deep copy of this object. Read-only state of the object is not copied; the new object will be read-write by default.

Inherently immutable objects may optionally return the same object without modification from clone(), rather than constructing a new instance.

Specified by:

clone in interface DataObject

Overrides:

clone in class java.lang.Object

Returns:

a new object that is a deep copy of this object; for immutable objects, the same object may optionally be returned.

setReadOnly

public void setReadOnly()

Description copied from interface: DataObject

Set this object to be "read-only". Any subsequent attempt to modify this object will throw IllegalStateException. Once an object has been made read-only, it cannot be later set to read-write - this is a "one-way" operation.

Note that a read-only object is not necessarily immutable; if reference types are returned from accessors, then callers could theoretically mutate those objects even if the top-level object is marked as read-only. The ability to make objects read-only is intended to catch programming errors (e.g. attempting to modify a data object passed as part of a SLEE event), not to provide an absolute guarantee of immutability.

Calling setReadOnly() on an object that is already read-only is a no-op.

Some DataObject implementations may be inherently immutable. In those cases, they are considered always read-only.

Specified by:

setReadOnly in interface DataObject

isReadOnly

public boolean isReadOnly()

Description copied from interface: DataObject

Check if this object has been set read-only.

Specified by:

isReadOnly in interface DataObject

Returns:

true if the object is read-only or inherently immutable

See Also:

DataObject.setReadOnly()