rescuecore2.messages.components

Class EntityListComponent

java.lang.Object

rescuecore2.messages.AbstractMessageComponent

rescuecore2.messages.components.EntityListComponent

All Implemented Interfaces:

MessageComponent

public class EntityListComponent
extends AbstractMessageComponent

An EntityList component to a message.

Constructor Summary

Constructors

Constructor and Description
EntityListComponent(java.lang.String name) Construct an EntityListComponent with no content.
EntityListComponent(java.lang.String name, java.util.Collection<? extends Entity> entities) Construct an EntityListComponent with a specific list of entities.

Method Summary

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

EntityListComponent

public EntityListComponent(java.lang.String name)

Construct an EntityListComponent with no content.

Parameters:

name - The name of the component.

EntityListComponent

public EntityListComponent(java.lang.String name,
                           java.util.Collection<? extends Entity> entities)

Construct an EntityListComponent with a specific list of entities.

Parameters:

name - The name of the component.

entities - The entities in this message component.

Method Detail

getEntities

public java.util.List<Entity> getEntities()

Get the entities that make up this message component.

Returns:

The entities in this component.

setEntities

public void setEntities(java.util.Collection<? extends Entity> entities)

Set the entities that make up this message component.

Parameters:

entities - The entities 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