org.maestro.client.notes

Class DrainCompleteNotification

java.lang.Object

org.maestro.client.notes.MaestroEvent<MaestroEventListener>

org.maestro.client.notes.MaestroNotification

org.maestro.client.notes.DrainCompleteNotification

All Implemented Interfaces:

MaestroNote

public class DrainCompleteNotification
extends MaestroNotification

Constructor Summary

Constructors

Constructor and Description
DrainCompleteNotification()
DrainCompleteNotification(org.msgpack.core.MessageUnpacker unpacker)

Method Summary

Modifier and Type	Method and Description
MessageCorrelation	correlate()
void	correlate(MaestroNote note)
void	correlate(MessageCorrelation correlation)
boolean	correlatesTo(MaestroNote note)
boolean	correlatesTo(MessageCorrelation correlation)
MaestroCommand	getMaestroCommand() Gets the Maestro command for the note
String	getMessage()
MaestroNoteType	getNoteType() Gets the note type
boolean	isSuccessful()
void	notify(MaestroEventListener visitor)
protected org.msgpack.core.MessageBufferPacker	pack()
byte[]	serialize() Serialize the note
void	setMessage(String message)
void	setSuccessful(boolean successful)
String	toString() Converts the note to string for debugging purposes

Methods inherited from class org.maestro.client.notes.MaestroNotification

getId, getName, setId, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.maestro.common.client.notes.MaestroNote

hasNext, next

Constructor Detail

DrainCompleteNotification

public DrainCompleteNotification()

DrainCompleteNotification

public DrainCompleteNotification(org.msgpack.core.MessageUnpacker unpacker)
                          throws IOException

Throws:

IOException

Method Detail

isSuccessful

public boolean isSuccessful()

setSuccessful

public void setSuccessful(boolean successful)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

notify

public void notify(MaestroEventListener visitor)

Specified by:

notify in class MaestroEvent<MaestroEventListener>

pack

protected org.msgpack.core.MessageBufferPacker pack()
                                             throws IOException

Overrides:

pack in class MaestroNotification

Throws:

IOException

toString

public String toString()

Description copied from interface: MaestroNote

Converts the note to string for debugging purposes

Specified by:

toString in interface MaestroNote

Overrides:

toString in class MaestroNotification

Returns:

the note in String format

getNoteType

public MaestroNoteType getNoteType()

Description copied from interface: MaestroNote

Gets the note type

Specified by:

getNoteType in interface MaestroNote

Returns:

the note type

getMaestroCommand

public MaestroCommand getMaestroCommand()

Description copied from interface: MaestroNote

Gets the Maestro command for the note

Specified by:

getMaestroCommand in interface MaestroNote

Returns:

the maestro command as an instance of MaestroCommand

correlate

public MessageCorrelation correlate()

Specified by:

correlate in interface MaestroNote

correlate

public void correlate(MessageCorrelation correlation)

Specified by:

correlate in interface MaestroNote

correlate

public void correlate(MaestroNote note)

Specified by:

correlate in interface MaestroNote

correlatesTo

public boolean correlatesTo(MessageCorrelation correlation)

Specified by:

correlatesTo in interface MaestroNote

correlatesTo

public boolean correlatesTo(MaestroNote note)

Specified by:

correlatesTo in interface MaestroNote

serialize

public final byte[] serialize()
                       throws IOException

Description copied from interface: MaestroNote

Serialize the note

Specified by:

serialize in interface MaestroNote

Returns:

The serialized note

Throws:

IOException - if unable to serialize the note