com.opensymphony.module.sitemesh

Interface SitemeshWriter

All Known Implementing Classes:

OutputLengthObservantSitemeshWriter, RoutablePrintWriter, SecondaryStorageBufferWriter, 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
void	close() Taken from Writer
void	flush() Taken from Writer
SitemeshBuffer	getSitemeshBuffer() Get the underlying buffer for the writer
java.io.Writer	getUnderlyingWriter() Because writer is a class and not an interface we need a way to self reference so we can pass the underlying Writer onto other Writers.
void	write(char[] chars) Taken from Writer
void	write(char[] chars, int off, int len) Taken from Writer
void	write(int c) Taken from Writer
void	write(java.lang.String str) Taken from Writer
void	write(java.lang.String str, int off, int len) Taken from Writer
boolean	writeSitemeshBufferFragment(SitemeshBufferFragment bufferFragment) Write a sitemesh buffer fragment to the writer.

Method Detail

getUnderlyingWriter

java.io.Writer getUnderlyingWriter()

Because writer is a class and not an interface we need a way to self reference so we can pass the underlying Writer onto other Writers.

Returns:

a self reference to this so it can be wrapped say.

write

void write(int c)
    throws java.io.IOException

Taken from Writer

Parameters:

c - the character to write

Throws:

java.io.IOException

write

void write(char[] chars,
           int off,
           int len)
    throws java.io.IOException

Taken from Writer

Parameters:

chars - the characters to write

off - the offset to write from

len - the length to write

Throws:

java.io.IOException

write

void write(char[] chars)
    throws java.io.IOException

Taken from Writer

Parameters:

chars - the characters to write

Throws:

java.io.IOException

write

void write(java.lang.String str,
           int off,
           int len)
    throws java.io.IOException

Taken from Writer

Parameters:

str - the characters to write

off - the offset to write from

len - the length to write

Throws:

java.io.IOException

write

void write(java.lang.String str)
    throws java.io.IOException

Taken from Writer

Parameters:

str - the characters to write

Throws:

java.io.IOException

flush

void flush()
    throws java.io.IOException

Taken from Writer

Throws:

java.io.IOException

close

void close()
    throws java.io.IOException

Taken from Writer

Throws:

java.io.IOException

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