IntSeq Class Reference
[Built-in Sequences]

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

Inheritance diagram for IntSeq:

AbstractPrimitiveSequence AbstractSequence Sequence Copyable Sequence

List of all members.

Public Member Functions

 IntSeq ()
 Constructs an empty sequence of integers with an initial maximum of zero.
 IntSeq (int initialMaximum)
 Constructs an empty sequence of integers with the given initial maximum.
 IntSeq (int[] ints)
 Constructs a new sequence containing the given integers.
boolean addAllInt (int[] elements, int offset, int length)
 Append length elements from the given array to this sequence, starting at index offset in that array.
boolean addAllInt (int[] elements)
void addInt (int element)
 Append the element to the end of the sequence.
void addInt (int index, int element)
 Shift all elements in the sequence starting from the given index and add the element to the given index.
int getInt (int index)
 Returns the integer at the given index.
int setInt (int index, int element)
 Set the new integer at the given index and return the old integer.
void setInt (int dstIndex, int[] elements, int srcIndex, int length)
 Copy a portion of the given array into this sequence.
int[] toArrayInt (int[] 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 getInt(int) that returns a java.lang.Integer.
Object set (int index, Object element)
 A wrapper for setInt().
void add (int index, Object element)
 A wrapper for addInt(int, int).


Detailed Description

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

Instantiates:
<<generic>> com.rti.dds.util.Sequence
See also:
int

com.rti.dds.util.Sequence


Constructor & Destructor Documentation

IntSeq (  ) 

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

IntSeq ( int  initialMaximum  ) 

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

IntSeq ( int[]  ints  ) 

Constructs a new sequence containing the given integers.

Parameters:
ints the initial contents of this sequence
Exceptions:
NullPointerException if the input array is null


Member Function Documentation

boolean addAllInt ( int[]  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 addAllInt ( int[]  elements  ) 

Exceptions:
NullPointerException if the given array is null

void addInt ( int  element  ) 

Append the element to the end of the sequence.

void addInt ( int  index,
int  element 
)

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

int getInt ( int  index  ) 

Returns the integer at the given index.

Exceptions:
IndexOutOfBoundsException if the index is out of bounds.

int setInt ( int  index,
int  element 
)

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

Exceptions:
IndexOutOfBoundsException if the index is out of bounds.

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

int [] toArrayInt ( int[]  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 getInt(int) that returns a java.lang.Integer.

See also:
java.util.List.get(int)

Implements AbstractPrimitiveSequence.

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

A wrapper for setInt().

Exceptions:
ClassCastException if the element is not of type Integer.
See also:
java.util.List.set(int, java.lang.Object)

Implements AbstractPrimitiveSequence.

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

A wrapper for addInt(int, int).

Exceptions:
ClassCastException if the element is not of type Integer.
See also:
java.util.List.add(int, java.lang.Object)

Implements AbstractPrimitiveSequence.


RTI Connext Java API Version 4.5f Copyright © 17 Mar 2012 Real-Time Innovations, Inc