rescuecore2.messages.components

Class StringComponent

java.lang.Object

rescuecore2.messages.AbstractMessageComponent

rescuecore2.messages.components.StringComponent

All Implemented Interfaces:

MessageComponent

public class StringComponent
extends AbstractMessageComponent

A string component to a message.

Constructor Summary

Constructors

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

Method Summary

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

StringComponent

public StringComponent(java.lang.String name)

Construct a StringComponent with no content.

Parameters:

name - The name of the component.

StringComponent

public StringComponent(java.lang.String name,
                       java.lang.String value)

Construct a StringComponent with a specific value.

Parameters:

name - The name of the component.

value - The value of this component.

Method Detail

getValue

public java.lang.String getValue()

Get the value of this message component.

Returns:

The value of the component.

setValue

public void setValue(java.lang.String value)

Set the value of this message component.

Parameters:

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