rescuecore2.log

Class CommandsRecord

java.lang.Object

rescuecore2.log.CommandsRecord

All Implemented Interfaces:

LogRecord

public class CommandsRecord
extends java.lang.Object
implements LogRecord

A commands record.

Constructor Summary

Constructors

Constructor and Description
CommandsRecord(java.io.InputStream in) Construct a new CommandsRecord and read data from an InputStream.
CommandsRecord(int time, java.util.Collection<Command> commands) Construct a new CommandsRecord.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Command>	getCommands() Get the commands.
RecordType	getRecordType() Get the type of this record.
int	getTime() Get the timestamp for this record.
void	read(java.io.InputStream in) Read this log record's data from a stream.
void	write(java.io.OutputStream out) Write this log record to a stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandsRecord

public CommandsRecord(int time,
                      java.util.Collection<Command> commands)

Construct a new CommandsRecord.

Parameters:

time - The timestep of this commands record.

commands - The set of agent commands.

CommandsRecord

public CommandsRecord(java.io.InputStream in)
               throws java.io.IOException,
                      LogException

Construct a new CommandsRecord and read data from an InputStream.

Parameters:

in - The InputStream to read from.

Throws:

java.io.IOException - If there is a problem reading the stream.

LogException - If there is a problem reading the log record.

Method Detail

getRecordType

public RecordType getRecordType()

Description copied from interface: LogRecord

Get the type of this record.

Specified by:

getRecordType in interface LogRecord

Returns:

The record type.

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Description copied from interface: LogRecord

Write this log record to a stream.

Specified by:

write in interface LogRecord

Parameters:

out - The OutputStream to write to.

Throws:

java.io.IOException - If there is a problem writing to the stream.

read

public void read(java.io.InputStream in)
          throws java.io.IOException,
                 LogException

Description copied from interface: LogRecord

Read this log record's data from a stream.

Specified by:

read in interface LogRecord

Parameters:

in - The InputStream to read from.

Throws:

java.io.IOException - If there is a problem reading the stream.

LogException - If there is a problem reading the log record.

getTime

public int getTime()

Get the timestamp for this record.

Returns:

The timestamp.

getCommands

public java.util.Collection<Command> getCommands()

Get the commands.

Returns:

The commands.