rescuecore2.messages.components

Class EntityIDComponent

java.lang.Object

rescuecore2.messages.AbstractMessageComponent

rescuecore2.messages.components.EntityIDComponent

All Implemented Interfaces:

MessageComponent

public class EntityIDComponent
extends AbstractMessageComponent

An EntityID component to a message.

Constructor Summary

Constructors

Constructor and Description
EntityIDComponent(java.lang.String name) Construct an EntityIDComponent with no content.
EntityIDComponent(java.lang.String name, EntityID value) Construct an EntityIDComponent with a specific value.

Method Summary

Modifier and Type	Method and Description
EntityID	getValue() Get the value of this message component.
void	read(java.io.InputStream in) Read this component from a stream.
void	setValue(EntityID id) Set the value of 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

EntityIDComponent

public EntityIDComponent(java.lang.String name)

Construct an EntityIDComponent with no content.

Parameters:

name - The name of the component.

EntityIDComponent

public EntityIDComponent(java.lang.String name,
                         EntityID value)

Construct an EntityIDComponent with a specific value.

Parameters:

name - The name of the component.

value - The value of this component.

Method Detail

getValue

public EntityID getValue()

Get the value of this message component.

Returns:

The value of the component.

setValue

public void setValue(EntityID id)

Set the value of this message component.

Parameters:

id - The new value of the 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