RTI Connext Java API Version 7.1.0

Declares IDL sequence < com.rti.dds.infrastructure.String > . More...

Inheritance diagram for StringSeq:
Copyable WstringSeq

Public Member Functions

 StringSeq ()
 Constructs an empty sequence of strings with an initial maximum of zero. More...
 StringSeq (int initialMaximum)
 Constructs an empty sequence of strings with the given initial maximum. More...
 StringSeq (Collection<?> strings)
 Constructs a new sequence containing the given strings. More...
final Object copy_from (Object src)
Object copy_from (Object src)
 Copy value of a data type from source. More...

Static Public Member Functions

static void readStringArray (String[] value, CdrObjectInput in, int length) throws IOException
static void writeStringArray (String[] value, CdrObjectOutput out, int length, int maxStringLength) throws IOException

Detailed Description

Declares IDL sequence < com.rti.dds.infrastructure.String > .

See also

Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence < com.rti.dds.infrastructure.String > with value type semantics.

StringSeq is a sequence that contains strings.

<<generic>> com.rti.dds.infrastructure.com.rti.dds.util.Sequence
See also

Constructor & Destructor Documentation

◆ StringSeq() [1/3]

StringSeq ( )

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

Referenced by StringSeq.copy_from().

◆ StringSeq() [2/3]

StringSeq ( int  initialMaximum)

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

◆ StringSeq() [3/3]

StringSeq ( Collection<?>  strings)

Constructs a new sequence containing the given strings.

stringsthe initial contents of this sequence
NullPointerExceptionif the input collection is null

Member Function Documentation

◆ copy_from()

final Object copy_from ( Object  src)

Copy data into this object from another. The result of this method is that both this and src will be the same size and contain the same data.

srcThe Object which contains the data to be copied
Generally, return this but special cases (such as Enum) exist.
NullPointerExceptionIf src is null OR if there are null objects contained in this sequence.
ClassCastExceptionIf src is not the same type as this.
See also

Implements Copyable.

References StringSeq.StringSeq().

Referenced by QueryConditionParams.copy_from(), TopicQuerySelection.copy_from(), and QueryConditionParams.QueryConditionParams().

◆ readStringArray()

static void readStringArray ( String[]  value,
CdrObjectInput  in,
int  length 
) throws IOException

Read array of strings. The length specified must match the expected length of array. Otherwise, the stream will be positioned incorrectly, leading to corrupt reads. The length of array must be at least the value of length parameter (otherwise, ArrayOutOfBoundException will be thrown).

valuearray to read into
inInterface for reading object in CDR encoding.
lengththe length of array (<= value.length)

◆ writeStringArray()

static void writeStringArray ( String[]  value,
CdrObjectOutput  out,
int  length,
int  maxStringLength 
) throws IOException

Write array of string up to the specified length