CharSeq Class Reference
[Built-in Sequences]

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

Inheritance diagram for CharSeq:

List of all members.

Public Member Functions
	CharSeq ()
	Constructs an empty sequence of single-byte (serialized) characters with an initial maximum of zero.
	CharSeq (int initialMaximum)
	Constructs an empty sequence of single-byte (serialized) characters with the given initial maximum.
	CharSeq (char[] chars)
	Constructs a new sequence containing the given single-byte (serialized) characters.
final boolean	addAllChar (char[] elements, int offset, int length)
	Append length elements from the given array to this sequence, starting at index offset in that array.
final boolean	addAllChar (char[] elements)
	Append the elements of the given array into this sequence.
final void	addChar (char element)
	Append the element to the end of the sequence.
final void	addChar (int index, char element)
	Shift all elements in the sequence starting from the given index and add the element to the given index.
final char	getChar (int index)
	Returns the character at the given index.
final char	setChar (int index, char element)
	Set the new character at the given index and return the old character.
final void	setChar (int dstIndex, char[] elements, int srcIndex, int length)
	Copy a portion of the given array into this sequence.
final char[]	toArrayChar (char[] array)
	Return an array containing copy of the contents of this sequence.
final int	getMaximum ()
	Get the current maximum number of elements that can be stored in this sequence.
final Object	get (int index)
	A wrapper for getChar(int) that returns a java.lang.Character.
final Object	set (int index, Object element)
	A wrapper for setChar().
final void	add (int index, Object element)
	A wrapper for addChar(int, int).

---

Detailed Description

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

Instantiates:

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

See also:

char

com.rti.dds.util.Sequence

---

Constructor & Destructor Documentation

CharSeq

(

)

Constructs an empty sequence of single-byte (serialized) characters with an initial maximum of zero.

CharSeq

(

int

initialMaximum

)

Constructs an empty sequence of single-byte (serialized) characters with the given initial maximum.

CharSeq

(

char[]

chars

)

Constructs a new sequence containing the given single-byte (serialized) characters.

Parameters:

chars

the initial contents of this sequence

---

Member Function Documentation

final boolean addAllChar	(	char[]	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.

final boolean addAllChar

(

char[]

elements

)

Append the elements of the given array into this sequence.

Exceptions:

NullPointerException

if the given array is null

final void addChar

(

char

element

)

Append the element to the end of the sequence.

final void addChar	(	int	index,
		char	element
	)

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

final char getChar

(

int

index

)

Returns the character at the given index.

Exceptions:

IndexOutOfBoundsException

if the index is out of bounds.

final char setChar	(	int	index,
		char	element
	)

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

Exceptions:

IndexOutOfBoundsException

if the index is out of bounds.

final void setChar	(	int	dstIndex,
		char[]	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.

final char [] toArrayChar

(

char[]

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.

final 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.

final Object get

(

int

index

)

[virtual]

A wrapper for getChar(int) that returns a java.lang.Character.

See also:

java.util.List.get(int)

Implements AbstractPrimitiveSequence.

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

A wrapper for setChar().

Exceptions:

ClassCastException

if the element is not of type Character.

See also:

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

Implements AbstractPrimitiveSequence.

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

A wrapper for addChar(int, int).

Exceptions:

ClassCastException

if the element is not of type Character.

See also:

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

Implements AbstractPrimitiveSequence.