rescuecore2.messages.components

Class EntityComponent

java.lang.Object

rescuecore2.messages.AbstractMessageComponent

rescuecore2.messages.components.EntityComponent

All Implemented Interfaces:

MessageComponent

public class EntityComponent
extends AbstractMessageComponent

An Entity component to a message.

Constructor Summary

Constructors

Constructor and Description
EntityComponent(java.lang.String name) Construct an EntityComponent with no content.
EntityComponent(java.lang.String name, Entity entity) Construct an EntityComponent with a specific entity value.

Method Summary

Modifier and Type	Method and Description
Entity	getEntity() Get the entity.
void	read(java.io.InputStream in) Read this component from a stream.
void	setEntity(Entity e) Set the entity.
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

EntityComponent

public EntityComponent(java.lang.String name)

Construct an EntityComponent with no content.

Parameters:

name - The name of the component.

EntityComponent

public EntityComponent(java.lang.String name,
                       Entity entity)

Construct an EntityComponent with a specific entity value.

Parameters:

name - The name of the component.

entity - The value of this component.

Method Detail

getEntity

public Entity getEntity()

Get the entity.

Returns:

The entity.

setEntity

public void setEntity(Entity e)

Set the entity.

Parameters:

e - The new entity.

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