SecondaryStorageBufferWriter (sitemesh 2.5.0 API)

java.lang.Object
- java.io.Writer
- - com.opensymphony.module.sitemesh.util.CharArrayWriter
  - - com.opensymphony.module.sitemesh.scalability.secondarystorage.SecondaryStorageBufferWriter

All Implemented Interfaces:

SitemeshWriter, java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable
```
public class SecondaryStorageBufferWriter
extends CharArrayWriter
implements SitemeshWriter
```
This writer allows for secondary storage to be use If the body of the response its really large
It will ensure that everything up to the <body> tage is in memory before spilling over, so that further parsing can use memory access to find important page details. But if the page gets really large then it will spill into the secondary storage area.
This of course falls down if the <head> section was megabytes in size say but we are deliberately not catering for this situation and hence it would be worse than SiteMesh without spill over.

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
`SecondaryStorageBufferWriter(int initialBufferSize, SecondaryStorage secondaryStorage)`
`SecondaryStorageBufferWriter(SecondaryStorage secondaryStorage)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`void`	`write(char[] chars)` Taken from `Writer`
`void`	`write(char[] chars, int off, int len)` Writes characters to the buffer.
`void`	`write(int c)` Writes a character to the buffer.
`void`	`write(java.lang.String str)` Taken from `Writer`
`void`	`write(java.lang.String str, int off, int len)` Write a portion of a string to the buffer.
`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, writeTo

Methods inherited from class java.io.Writer
append, append, append

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

- Constructor Detail
  - SecondaryStorageBufferWriter
```
public SecondaryStorageBufferWriter(SecondaryStorage secondaryStorage)
```
  - SecondaryStorageBufferWriter
```
public SecondaryStorageBufferWriter(int initialBufferSize,
                                    SecondaryStorage secondaryStorage)
```
- 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)
```
    Description copied from class: CharArrayWriter
    
    Writes a character to the buffer.
    
    Specified by:
    
    write in interface SitemeshWriter
    
    Overrides:
    
    write in class CharArrayWriter
    
    Parameters:
    
    c - the character to write
  - write
```
public void write(char[] chars,
                  int off,
                  int len)
```
    Description copied from class: CharArrayWriter
    
    Writes characters to the buffer.
    
    Specified by:
    
    write in interface SitemeshWriter
    
    Overrides:
    
    write in class CharArrayWriter
    
    Parameters:
    
    chars - the data to be written
    
    off - the start offset in the data
    
    len - the number of chars that are written
  - 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)
```
    Description copied from class: CharArrayWriter
    
    Write a portion of a string to the buffer.
    
    Specified by:
    
    write in interface SitemeshWriter
    
    Overrides:
    
    write in class CharArrayWriter
    
    Parameters:
    
    str - String to be written from
    
    off - Offset from which to start reading characters
    
    len - Number of characters to be written
  - 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
  - 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

Class SecondaryStorageBufferWriter

Field Summary

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

Fields inherited from class java.io.Writer

Constructor Summary

Method Summary

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

Methods inherited from class java.io.Writer

Methods inherited from class java.lang.Object

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

Constructor Detail

SecondaryStorageBufferWriter

SecondaryStorageBufferWriter

Method Detail

getUnderlyingWriter

write

write

write

write

write

writeSitemeshBufferFragment

getSitemeshBuffer