RTI Connext Java API  Version 5.1.0
Bytes Class Reference

Built-in type consisting of a variable-length array of opaque bytes. More...

Inheritance diagram for Bytes:
Copyable

Public Member Functions

 Bytes ()
 Default Constructor.
 
 Bytes (Bytes src)
 Copy constructor.
 
 Bytes (int theLength)
 Constructor that specifies the size of the allocated bytes array.
 
 Bytes (byte[] src)
 
Object copy_from (Object src)
 Copy src into this object.
 
- Public Member Functions inherited from Copyable
Object copy_from (Object src)
 Copy value of a data type from source.
 

Public Attributes

int length
 Number of bytes to serialize.
 
int offset
 Offset from which to start serializing bytes .
 
byte[] value
 com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes array value.
 

Detailed Description

Built-in type consisting of a variable-length array of opaque bytes.

Constructor & Destructor Documentation

Bytes ( )

Default Constructor.

The default constructor initializes the newly created object with null value, zero length, and zero offset.

Bytes ( Bytes  src)

Copy constructor.

Parameters
src<<in>> Object to copy from.
Exceptions
NullPointerExceptionif src is null.
Bytes ( int  theLength)

Constructor that specifies the size of the allocated bytes array.

After this method is called, length and offset are set to zero.

Parameters
size<<in>> Size of the allocated bytes array.
Exceptions
IllegalArgumentExceptionif size is negative
Bytes ( byte[]  src)

Create a new Bytes object to wrap the given array.

The value field will point to the given array. The offset will be set to 0. The length will be set to the length of the array unless the array is null, in which case the length will be set to 0 also.

Member Function Documentation

Object copy_from ( Object  src)

Copy src into this object.

This method performs a deep copy of src and it allocates memory for the value if required.

Parameters
src<<in>> Object to copy from.
Returns
this if success. Otherwise, null.
Exceptions
NullPointerExceptionif src is null.

Member Data Documentation

int length

Number of bytes to serialize.

int offset

Offset from which to start serializing bytes .

The first position of the bytes array has offset 0.

byte [] value

com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes array value.


RTI Connext Java API Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc