com.opensymphony.module.sitemesh

Class SitemeshBufferWriter

java.lang.Object

java.io.Writer

com.opensymphony.module.sitemesh.util.CharArrayWriter

com.opensymphony.module.sitemesh.SitemeshBufferWriter

All Implemented Interfaces:

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

public class SitemeshBufferWriter
extends CharArrayWriter
implements SitemeshWriter

A char array writer that caches other sitemesh buffers written to it, so that it doesn't have to continually copy them from buffer to buffer.

Field Summary

Fields inherited from class com.opensymphony.module.sitemesh.util.CharArrayWriter

buf, count

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
SitemeshBufferWriter()
SitemeshBufferWriter(int initialSize)

Method Summary

Modifier and Type	Method and Description
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.
boolean	writeSitemeshBufferFragment(SitemeshBufferFragment bufferFragment) Write a sitemesh buffer fragment to the writer.

Methods inherited from class com.opensymphony.module.sitemesh.util.CharArrayWriter

close, flush, reset, size, toCharArray, toString, write, write, write, writeTo

Methods inherited from class java.io.Writer

append, append, append, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.module.sitemesh.SitemeshWriter

close, flush, write, write, write, write, write

Constructor Detail

SitemeshBufferWriter

public SitemeshBufferWriter()

SitemeshBufferWriter

public SitemeshBufferWriter(int initialSize)

Method Detail

getUnderlyingWriter

public java.io.Writer getUnderlyingWriter()

Description copied from interface: SitemeshWriter

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.

Specified by:

getUnderlyingWriter in interface SitemeshWriter

Returns:

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

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