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

Built-in type consisting of a variable-length array of opaque bytes and a string that is the key. More...

Inheritance diagram for KeyedBytes:
Copyable

Public Member Functions

 KeyedBytes ()
 Default Constructor.
 
 KeyedBytes (KeyedBytes src)
 Copy constructor.
 
 KeyedBytes (int theLength)
 Constructor that specifies the allocated sizes.
 
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

String key
 Instance key associated with the specified value.
 
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 and a string that is the key.

Constructor & Destructor Documentation

Default Constructor.

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

Copy constructor.

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

Constructor that specifies the allocated sizes.

After this method is called, key is initialized with the empty string and length and offset are set to zero.

Parameters
theLength<<in>> Size of the allocated bytes array.
Exceptions
IllegalArgumentExceptionif size is negative

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

String key

Instance key associated with the specified value.

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.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc