rescuecore2.messages.components

Class EntityIDListComponent

java.lang.Object

rescuecore2.messages.AbstractMessageComponent

rescuecore2.messages.components.EntityIDListComponent

All Implemented Interfaces:

MessageComponent

public class EntityIDListComponent
extends AbstractMessageComponent

A message component that is a list of entity IDs.

Constructor Summary

Constructors

Constructor and Description
EntityIDListComponent(java.lang.String name) Construct an EntityIDListComponent with no data.
EntityIDListComponent(java.lang.String name, java.util.List<EntityID> ids) Construct an EntityIDListComponent with a list of entity IDs.

Method Summary

Modifier and Type	Method and Description
java.util.List<EntityID>	getIDs() Get the list of entity IDs in this component.
void	read(java.io.InputStream in) Read this component from a stream.
void	setIDs(java.util.List<EntityID> newIDs) Set the list of entity IDs 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

EntityIDListComponent

public EntityIDListComponent(java.lang.String name)

Construct an EntityIDListComponent with no data.

Parameters:

name - The name of the component.

EntityIDListComponent

public EntityIDListComponent(java.lang.String name,
                             java.util.List<EntityID> ids)

Construct an EntityIDListComponent with a list of entity IDs.

Parameters:

name - The name of the component.

ids - The data.

Method Detail

getIDs

public java.util.List<EntityID> getIDs()

Get the list of entity IDs in this component.

Returns:

An immutable view of the list of entity IDs.

setIDs

public void setIDs(java.util.List<EntityID> newIDs)

Set the list of entity IDs in this component.

Parameters:

newIDs - The new set of entity IDs.

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