StringSeq Class Reference

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

Inheritance diagram for StringSeq:

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

com.rti.dds.infrastructure.com.rti.dds.util.Sequence

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.

Instantiates:

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

See also

com.rti.dds.infrastructure.com.rti.dds.util.Sequence

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.

Parameters

strings

the initial contents of this sequence

Exceptions

NullPointerException

if 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.

Parameters

src	The Object which contains the data to be copied

Returns

Generally, return this but special cases (such as Enum) exist.

Exceptions

NullPointerException	If src is null OR if there are null objects contained in this sequence.
ClassCastException	If src is not the same type as this.

See also

com.rti.dds.infrastructure.Copyable::copy_from(java.lang.Object)

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

static

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

Parameters

value	array to read into
in	Interface for reading object in CDR encoding.
length	the length of array (<= value.length)

writeStringArray()

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

static

Write array of string up to the specified length