org.glyptodon.guacamole.io

Interface GuacamoleWriter

All Known Implementing Classes:

FilteredGuacamoleWriter, WriterGuacamoleWriter

public interface GuacamoleWriter

Provides abstract and raw character write access to a stream of Guacamole instructions.

Author:

Michael Jumper

Method Summary

Methods

Modifier and Type	Method and Description
void	write(char[] chunk) Writes the entire given array of characters to the Guacamole instruction stream.
void	write(char[] chunk, int off, int len) Writes a portion of the given array of characters to the Guacamole instruction stream.
void	writeInstruction(GuacamoleInstruction instruction) Writes the given fully parsed instruction to the Guacamole instruction stream.

Method Detail

write

void write(char[] chunk,
         int off,
         int len)
           throws GuacamoleException

Writes a portion of the given array of characters to the Guacamole instruction stream. The portion must contain only complete Guacamole instructions.

Parameters:

chunk - An array of characters containing Guacamole instructions.

off - The start offset of the portion of the array to write.

len - The length of the portion of the array to write.

Throws:

GuacamoleException - If an error occurred while writing the portion of the array specified.

write

void write(char[] chunk)
           throws GuacamoleException

Writes the entire given array of characters to the Guacamole instruction stream. The array must consist only of complete Guacamole instructions.

Parameters:

chunk - An array of characters consisting only of complete Guacamole instructions.

Throws:

GuacamoleException - If an error occurred while writing the the specified array.

writeInstruction

void writeInstruction(GuacamoleInstruction instruction)
                      throws GuacamoleException

Writes the given fully parsed instruction to the Guacamole instruction stream.

Parameters:

instruction - The Guacamole instruction to write.

Throws:

GuacamoleException - If an error occurred while writing the instruction.