StringSeq Class Reference
[String Built-in Type, Built-in Sequences]

Declares IDL sequence < String > . More...

Inheritance diagram for StringSeq:

List of all members.

Public Member Functions
	StringSeq ()
	Constructs an empty sequence of strings with an initial maximum of zero.
	StringSeq (int initialMaximum)
	Constructs an empty sequence of strings with the given initial maximum.
	StringSeq (Collection strings)
	Constructs a new sequence containing the given strings.
final Object	copy_from (Object src)
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 < String > .

See also:

com.rti.dds.util.Sequence

Instantiates com.rti.dds.util.Sequence < String > with value type semantics. StringSeq is a sequence that contains strings.

Instantiates:

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

See also:

com.rti.dds.util.Sequence

---

Constructor & Destructor Documentation

StringSeq

(

)

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

StringSeq

(

int

initialMaximum

)

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

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

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.

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)

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

Write array of string up to the specified length