org.maestro.common.client.notes

Interface MaestroNote

All Known Implementing Classes:

AbnormalDisconnect, AgentSourceRequest, DrainCompleteNotification, DrainRequest, FlushRequest, GetRequest, GetResponse, Halt, InternalError, LogRequest, LogResponse, MaestroEvent, MaestroNotification, MaestroRequest, MaestroResponse, OkResponse, PingRequest, PingResponse, ProtocolError, SetRequest, StartAgent, StartInspector, StartReceiver, StartSender, StatsRequest, StatsResponse, StopAgent, StopInspector, StopReceiver, StopSender, TestFailedNotification, TestSuccessfulNotification, UserCommand1Request, UserCommand1Response

public interface MaestroNote

A basic interface for Maestro Notes

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
MaestroNoteType	getNoteType() Gets the note type
default boolean	hasNext() Whether the note contains content that cannot be sent in a single exchange.
default void	next() Moves to the next subsequent note
byte[]	serialize() Serialize the note
String	toString() Converts the note to string for debugging purposes

Method Detail

getNoteType

MaestroNoteType getNoteType()

Gets the note type

Returns:

the note type

getMaestroCommand

MaestroCommand getMaestroCommand()

Gets the Maestro command for the note

Returns:

the maestro command as an instance of MaestroCommand

serialize

byte[] serialize()
          throws IOException

Serialize the note

Returns:

The serialized note

Throws:

IOException - if unable to serialize the note

toString

String toString()

Converts the note to string for debugging purposes

Overrides:

toString in class Object

Returns:

the note in String format

correlate

MessageCorrelation correlate()

correlate

void correlate(MessageCorrelation correlation)

correlate

void correlate(MaestroNote note)

correlatesTo

boolean correlatesTo(MessageCorrelation correlation)

correlatesTo

boolean correlatesTo(MaestroNote note)

next

default void next()

Moves to the next subsequent note

hasNext

default boolean hasNext()

Whether the note contains content that cannot be sent in a single exchange. The data navigation is done internally whenever the pack method is called. This should repeat until it returns false

Returns:

true if there's a subsequent note to be processed or false otherwise