ByteSeq Class Reference
[Built-in Sequences]

Instantiates com.rti.dds.util.Sequence < byte >. More...

Inheritance diagram for ByteSeq:

List of all members.

Public Member Functions
	ByteSeq ()
	Constructs an empty sequence of bytes with an initial maximum of zero.
	ByteSeq (int initialMaximum)
	Constructs an empty sequence of bytes with the given initial maximum.
	ByteSeq (byte[] bytes)
	Construct a new sequence containing the given bytes.
boolean	addAllByte (byte[] elements, int offset, int length)
	Append length elements from the given array to this sequence, starting at index offset in that array.
boolean	addAllByte (byte[] elements)
void	addByte (byte element)
	Append the element to the end of the sequence.
void	addByte (int index, byte element)
	Shift all elements in the sequence starting from the given index and add the element to the given index.
byte	getByte (int index)
	Returns the byte at the given index.
byte	setByte (int index, byte element)
	Set the new byte at the given index and return the old byte.
void	setByte (int dstIndex, byte[] elements, int srcIndex, int length)
	Copy a portion of the given array into this sequence.
byte[]	toArrayByte (byte[] array)
	Return an array containing copy of the contents of this sequence.
int	getMaximum ()
	Get the current maximum number of elements that can be stored in this sequence.
Object	get (int index)
	A wrapper for getByte(int) that returns a java.lang.Byte.
Object	set (int index, Object element)
	A wrapper for setByte().
void	add (int index, Object element)
	A wrapper for addByte(int, int).

---

Detailed Description

Instantiates com.rti.dds.util.Sequence < byte >.

Instantiates:

<<generic>> com.rti.dds.util.Sequence

See also:

byte

com.rti.dds.util.Sequence

---

Constructor & Destructor Documentation

ByteSeq

(

)

Constructs an empty sequence of bytes with an initial maximum of zero.

ByteSeq

(

int

initialMaximum

)

Constructs an empty sequence of bytes with the given initial maximum.

ByteSeq

(

byte[]

bytes

)

Construct a new sequence containing the given bytes.

Parameters:

bytes

the initial contents of this sequence

Exceptions:

NullPointerException

if the input array is null

---

Member Function Documentation

boolean addAllByte	(	byte[]	elements,
		int	offset,
		int	length
	)

Append length elements from the given array to this sequence, starting at index offset in that array.

Exceptions:

NullPointerException

if the given array is null.

boolean addAllByte

(

byte[]

elements

)

Exceptions:

NullPointerException

if the given array is null

void addByte

(

byte

element

)

Append the element to the end of the sequence.

void addByte	(	int	index,
		byte	element
	)

Shift all elements in the sequence starting from the given index and add the element to the given index.

byte getByte

(

int

index

)

Returns the byte at the given index.

Exceptions:

IndexOutOfBoundsException

if the index is out of bounds.

byte setByte	(	int	index,
		byte	element
	)

Set the new byte at the given index and return the old byte.

Exceptions:

IndexOutOfBoundsException

if the index is out of bounds.

void setByte	(	int	dstIndex,
		byte[]	elements,
		int	srcIndex,
		int	length
	)

Copy a portion of the given array into this sequence.

Parameters:

	dstIndex	the index at which to start copying into this sequence.
	elements	an array of primitive elements.
	srcIndex	the index at which to start copying from the given array.
	length	the number of elements to copy.

Exceptions:

IndexOutOfBoundsException

if copying would cause access of data outside array bounds.

byte [] toArrayByte

(

byte[]

array

)

Return an array containing copy of the contents of this sequence.

Parameters:

array

The array into which this sequence should be copied. It may be null. If it is, or if array length is too small, the array will be ignored, and a new array of the necessary length will be created and copied into instead.

Returns:

A non-null array containing a copy of the contents of this sequence.

int getMaximum

(

)

Get the current maximum number of elements that can be stored in this sequence.

The maximum of the sequence represents the maximum number of elements that the underlying buffer can hold. It does not represent the current number of elements.

The maximum is a non-negative number. It is initialized when the sequence is first created.

The maximum can be changed implicitly by adding an element to the sequence with add(), or explicitly by calling Sequence.setMaximum.

Returns:

the current maximum of the sequence.

See also:

Sequence.size()

Implements Sequence.

Object get

(

int

index

)

[virtual]

A wrapper for getByte(int) that returns a java.lang.Byte.

See also:

java.util.List.get(int)

Implements AbstractPrimitiveSequence.

Object set	(	int	index,
		Object	element
	)			[virtual]

A wrapper for setByte().

Exceptions:

ClassCastException

if the element is not of type Byte.

See also:

java.util.List.set(int, java.lang.Object)

Implements AbstractPrimitiveSequence.

void add	(	int	index,
		Object	element
	)			[virtual]

A wrapper for addByte(int, int).

Exceptions:

ClassCastException

if the element is not of type Byte.

See also:

java.util.List.add(int, java.lang.Object)

Implements AbstractPrimitiveSequence.