com.opensymphony.module.sitemesh.scalability.secondarystorage

Class NoopSecondaryStorage

java.lang.Object

com.opensymphony.module.sitemesh.scalability.secondarystorage.NoopSecondaryStorage

All Implemented Interfaces:

SecondaryStorage

public class NoopSecondaryStorage
extends java.lang.Object
implements SecondaryStorage

A secondary storage that does nothing.

Constructor Summary

Constructors

Constructor and Description
NoopSecondaryStorage()

Method Summary

Modifier and Type	Method and Description
void	cleanUp() This allows you to ask the secondary storage to clean up after itself.
long	getMemoryLimitBeforeUse() Returns the number of characters that should be stored in memory before this secondary storage.
void	write(char[] chars, int off, int len)
void	write(int c)
void	write(java.lang.String str)
void	write(java.lang.String str, int off, int len)
void	writeTo(java.io.Writer out) This method will close the "secondary storage" and write the captured output to the specified output writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoopSecondaryStorage

public NoopSecondaryStorage()

Method Detail

getMemoryLimitBeforeUse

public long getMemoryLimitBeforeUse()

Description copied from interface: SecondaryStorage

Returns the number of characters that should be stored in memory before this secondary storage. If this value is 0 or below then it is in fact disabled.

Specified by:

getMemoryLimitBeforeUse in interface SecondaryStorage

Returns:

the memory limits in force

write

public void write(int c)

Specified by:

write in interface SecondaryStorage

See Also:

Writer.write(int)

write

public void write(char[] chars,
                  int off,
                  int len)

Specified by:

write in interface SecondaryStorage

See Also:

Writer.write(char[], int, int)

write

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

Specified by:

write in interface SecondaryStorage

See Also:

Writer.write(String, int, int)

write

public void write(java.lang.String str)

Specified by:

write in interface SecondaryStorage

See Also:

Writer.write(String)

writeTo

public void writeTo(java.io.Writer out)

Description copied from interface: SecondaryStorage

This method will close the "secondary storage" and write the captured output to the specified output writer.

Specified by:

writeTo in interface SecondaryStorage

Parameters:

out - the output writer to send the stored data

cleanUp

public void cleanUp()

Description copied from interface: SecondaryStorage

This allows you to ask the secondary storage to clean up after itself. A try / finally would be a good place to put this.
This should be able to be called multiple times because we want to be able to always cleanup in case of exceptions as well an blue sky paths.
Really no exceptions should be propagated from this method.

Specified by:

cleanUp in interface SecondaryStorage