RTI Connext Java API  Version 5.0.0
ByteSeq Class Reference

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

Inheritance diagram for ByteSeq:
AbstractPrimitiveSequence AbstractSequence Sequence Copyable Sequence

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.
 
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).
 
- 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 < byte >

Instantiates:
<<generic>> com.rti.dds.infrastructure.com.rti.dds.util.Sequence
See Also
byte
com.rti.dds.infrastructure.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
bytesthe initial contents of this sequence
Exceptions
NullPointerExceptionif 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
NullPointerExceptionif the given array is null.
boolean addAllByte ( byte[]  elements)
Exceptions
NullPointerExceptionif 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
IndexOutOfBoundsExceptionif 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
IndexOutOfBoundsExceptionif 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
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.
byte [] toArrayByte ( byte[]  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.
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
ClassCastExceptionif 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
ClassCastExceptionif the element is not of type Byte.
See Also
java.util.List::add(int, java.lang.Object)

Implements AbstractPrimitiveSequence.


RTI Connext Java API Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc