com.opensymphony.module.sitemesh

Interface SitemeshWriter

All Known Implementing Classes:

RoutablePrintWriter, SitemeshBufferWriter, SitemeshPrintWriter

public interface SitemeshWriter

A sitemesh buffer writer. Provides the ability to defer the writing of a page body until it is finally written to the stream, so it isn't copied from buffer to buffer

Method Summary

Modifier and Type	Method and Description
SitemeshBuffer	getSitemeshBuffer() Get the underlying buffer for the writer
boolean	writeSitemeshBufferFragment(SitemeshBufferFragment bufferFragment) Write a sitemesh buffer fragment to the writer.

Method Detail

writeSitemeshBufferFragment

boolean writeSitemeshBufferFragment(SitemeshBufferFragment bufferFragment)
                             throws java.io.IOException

Write a sitemesh buffer fragment to the writer. This may not be written immediately, it may be stored and written later, when this buffer is written out to a writer.

Parameters:

bufferFragment - The buffer fragment to write

Returns:

True if the buffer was written immediately, or false if it will be written later

Throws:

java.io.IOException - If an IOException occurred

getSitemeshBuffer

SitemeshBuffer getSitemeshBuffer()

Get the underlying buffer for the writer

Returns:

The underlying buffer