RTI Connext Java API  Version 5.3.1
 All Classes Namespaces Functions Variables Groups Pages
CharSeq Class Reference

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

Inheritance diagram for CharSeq:
AbstractPrimitiveSequence AbstractSequence Sequence Copyable Sequence WcharSeq

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 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).
 
- Public Member Functions inherited from AbstractPrimitiveSequence
final Class getElementType ()
 
void loan (Object buffer, int new_length)
 Loan a contiguous buffer to this sequence.
 
void unloan ()
 Return the loaned buffer in the sequence and set the maximum to 0.
 
final boolean hasOwnership ()
 Return the value of the owned flag.
 
final void clear ()
 
final void setSize (int newSize)
 
final int size ()
 
final Object copy_from (Object src)
 
- Public Member Functions inherited from AbstractSequence
void add (int index, Object element)
 Inserts the specified element at the specified position in this sequence.
 
boolean add (Object element)
 Appends the specified element to the end of this sequence.
 
final Object remove (int index)
 Remove the element at the given index by shifting all subsequent elements "left" by one.
 
- Public Member Functions inherited from Sequence
int getMaximum ()
 Get the current maximum number of elements that can be stored in this sequence.
 
void setMaximum (int new_max)
 Resize this sequence to a new desired maximum.
 
Class getElementType ()
 

Detailed Description

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

Instantiates:
<<generic>> com.rti.dds.infrastructure.com.rti.dds.util.Sequence
See Also
char
com.rti.dds.infrastructure.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
charsthe 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
NullPointerExceptionif the given array is null.
final boolean addAllChar ( char[]  elements)

Append the elements of the given array into this sequence.

Exceptions
NullPointerExceptionif 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
IndexOutOfBoundsExceptionif 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
IndexOutOfBoundsExceptionif 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
dstIndexthe index at which to start copying into this sequence.
elementsan array of primitive elements.
srcIndexthe index at which to start copying from the given array.
lengththe number of elements to copy.
Exceptions
IndexOutOfBoundsExceptionif 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
arrayThe 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 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
ClassCastExceptionif 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
ClassCastExceptionif the element is not of type Character.
See Also
java.util.List::add(int, java.lang.Object)

Implements AbstractPrimitiveSequence.


RTI Connext Java API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc