com.opensymphony.module.sitemesh.scalability.outputlength

Class OutputLengthObservantSitemeshWriter

java.lang.Object

java.io.Writer

com.opensymphony.module.sitemesh.scalability.outputlength.OutputLengthObservantSitemeshWriter

All Implemented Interfaces:

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

public class OutputLengthObservantSitemeshWriter
extends java.io.Writer
implements SitemeshWriter

A SiteMeshWriter that can observe characters as they are written to out.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
OutputLengthObservantSitemeshWriter(OutputLengthObserver outputLengthObserver, SitemeshWriter delegate)

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.

Methods inherited from class java.io.Writer

append, append, append

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputLengthObservantSitemeshWriter

public OutputLengthObservantSitemeshWriter(OutputLengthObserver outputLengthObserver,
                                           SitemeshWriter delegate)

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.

write

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

Description copied from interface: SitemeshWriter

Taken from Writer

Specified by:

write in interface SitemeshWriter

Overrides:

write in class java.io.Writer

Parameters:

c - the character to write

Throws:

java.io.IOException

write

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

Description copied from interface: SitemeshWriter

Taken from Writer

Specified by:

write in interface SitemeshWriter

Specified by:

write in class java.io.Writer

Parameters:

chars - the characters to write

off - the offset to write from

len - the length to write

Throws:

java.io.IOException

write

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

Description copied from interface: SitemeshWriter

Taken from Writer

Specified by:

write in interface SitemeshWriter

Overrides:

write in class java.io.Writer

Parameters:

chars - the characters to write

Throws:

java.io.IOException

write

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

Description copied from interface: SitemeshWriter

Taken from Writer

Specified by:

write in interface SitemeshWriter

Overrides:

write in class java.io.Writer

Parameters:

str - the characters to write

off - the offset to write from

len - the length to write

Throws:

java.io.IOException

write

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

Description copied from interface: SitemeshWriter

Taken from Writer

Specified by:

write in interface SitemeshWriter

Overrides:

write in class java.io.Writer

Parameters:

str - the characters to write

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Description copied from interface: SitemeshWriter

Taken from Writer

Specified by:

flush in interface SitemeshWriter

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from interface: SitemeshWriter

Taken from Writer

Specified by:

close in interface SitemeshWriter

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException

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