rescuecore2.messages.components

Class CommandListComponent

java.lang.Object

rescuecore2.messages.AbstractMessageComponent

rescuecore2.messages.components.CommandListComponent

All Implemented Interfaces:

MessageComponent

public class CommandListComponent
extends AbstractMessageComponent

A message component made up of a list of agent commands.

Constructor Summary

Constructors

Constructor and Description
CommandListComponent(java.lang.String name) Construct a CommandListComponent with no content.
CommandListComponent(java.lang.String name, java.util.Collection<? extends Command> commands) Construct a CommandListComponent with a specific list of agent commands.

Method Summary

Modifier and Type	Method and Description
java.util.List<Command>	getCommands() Get the agent commands that make up this message component.
void	read(java.io.InputStream in) Read this component from a stream.
void	setCommands(java.util.Collection<? extends Command> commands) Set the commands that make up this message 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

CommandListComponent

public CommandListComponent(java.lang.String name)

Construct a CommandListComponent with no content.

Parameters:

name - The name of the component.

CommandListComponent

public CommandListComponent(java.lang.String name,
                            java.util.Collection<? extends Command> commands)

Construct a CommandListComponent with a specific list of agent commands.

Parameters:

name - The name of the component.

commands - The agent commands in this message component.

Method Detail

getCommands

public java.util.List<Command> getCommands()

Get the agent commands that make up this message component.

Returns:

The agent commands in this component.

setCommands

public void setCommands(java.util.Collection<? extends Command> commands)

Set the commands that make up this message component.

Parameters:

commands - The commands in this component.

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