rescuecore2.messages.components

Class StringListComponent

java.lang.Object

rescuecore2.messages.AbstractMessageComponent

rescuecore2.messages.components.StringListComponent

All Implemented Interfaces:

MessageComponent

public class StringListComponent
extends AbstractMessageComponent

A message component that is a list of strings.

Constructor Summary

Constructors

Constructor and Description
StringListComponent(java.lang.String name) Construct an StringListComponent with no data.
StringListComponent(java.lang.String name, java.util.List<java.lang.String> data) Construct an StringListComponent with a list of strings.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getValues() Get the list of Strings in this component.
void	read(java.io.InputStream in) Read this component from a stream.
void	setValues(java.util.List<java.lang.String> newData) Set the list of values in this component.
void	setValues(java.lang.String... newData) Set the list of values in this component.
java.lang.String	toString()
void	write(java.io.OutputStream out) Write this component to a stream.

Methods inherited from class rescuecore2.messages.AbstractMessageComponent

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringListComponent

public StringListComponent(java.lang.String name)

Construct an StringListComponent with no data.

Parameters:

name - The name of the component.

StringListComponent

public StringListComponent(java.lang.String name,
                           java.util.List<java.lang.String> data)

Construct an StringListComponent with a list of strings.

Parameters:

name - The name of the component.

data - The data.

Method Detail

getValues

public java.util.List<java.lang.String> getValues()

Get the list of Strings in this component.

Returns:

An immutable view of the list of Strings.

setValues

public void setValues(java.util.List<java.lang.String> newData)

Set the list of values in this component.

Parameters:

newData - The new set of values.

setValues

public void setValues(java.lang.String... newData)

Set the list of values in this component.

Parameters:

newData - The new set of values.

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Description copied from interface: MessageComponent

Write this component to a stream.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - If the write fails.

read

public void read(java.io.InputStream in)
          throws java.io.IOException

Description copied from interface: MessageComponent

Read this component from a stream.

Parameters:

in - The stream to read from.

Throws:

java.io.IOException - If the read fails.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object