org.springframework.extensions.surf.extensibility.impl

Class ModelWriter

java.lang.Object

java.io.Writer

org.springframework.extensions.surf.extensibility.impl.ModelWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class ModelWriter
extends Writer

An extension of the Writer class that is used with the ExtensibilityModel. Rather than writing directly to an output stream this writes to ExtensibilityContent instances in the ExtensibilityModel. This allows rendered content to be removed, replaced or added to as extensions to the model are processed.

Author:

David Draper

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
ModelWriter()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the current ExtensibilityContent instance.
void	flush() Flushes the current ExtensibilityContent instance.
ExtensibilityContent	getCurrentBufferElement() Returns the current ExtensibilityContent being written to.
void	setCurrentBufferElement(ExtensibilityContent bufferElement) Sets the current ExtensibilityContent to be written to.
void	write(char[] cbuf, int off, int len) Writes to the current ExtensibilityContent instance.
void	write(int c) Writes to the current ExtensibilityContent instance.
void	write(String str, int off, int len) Writes to the current ExtensibilityContent instance.

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, toString, wait, wait, wait

Constructor Detail

ModelWriter

public ModelWriter()

Method Detail

setCurrentBufferElement

public void setCurrentBufferElement(ExtensibilityContent bufferElement)

Sets the current ExtensibilityContent to be written to. This typically occurs when the processing of a new ExtensibilityDirective begins.

Parameters:

bufferElement - The element to start writing to.

getCurrentBufferElement

public ExtensibilityContent getCurrentBufferElement()

Returns the current ExtensibilityContent being written to.

Returns:

ExtensibilityContent

write

public void write(char[] cbuf,
         int off,
         int len)
           throws IOException

Writes to the current ExtensibilityContent instance.

Specified by:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Flushes the current ExtensibilityContent instance.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Closes the current ExtensibilityContent instance.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException

write

public void write(int c)
           throws IOException

Writes to the current ExtensibilityContent instance.

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
         int off,
         int len)
           throws IOException

Writes to the current ExtensibilityContent instance.

Overrides:

write in class Writer

Throws:

IOException