com.opensymphony.module.sitemesh.filter

Class SitemeshPrintWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

com.opensymphony.module.sitemesh.filter.SitemeshPrintWriter

All Implemented Interfaces:

SitemeshWriter, java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class SitemeshPrintWriter
extends java.io.PrintWriter
implements SitemeshWriter

A sitemesh print writer

Field Summary

Fields

Modifier and Type	Field and Description
private SitemeshWriter	sitemeshWriter

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
SitemeshPrintWriter(SitemeshBufferWriter sitemeshWriter)

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.

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

sitemeshWriter

private final SitemeshWriter sitemeshWriter

Constructor Detail

SitemeshPrintWriter

public SitemeshPrintWriter(SitemeshBufferWriter sitemeshWriter)

Method Detail

writeSitemeshBufferFragment

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

Description copied from interface: SitemeshWriter

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.

Specified by:

writeSitemeshBufferFragment in interface SitemeshWriter

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

public SitemeshBuffer getSitemeshBuffer()

Description copied from interface: SitemeshWriter

Get the underlying buffer for the writer

Specified by:

getSitemeshBuffer in interface SitemeshWriter

Returns:

The underlying buffer