com.opensymphony.module.sitemesh.html.util

Class StringSitemeshBuffer

java.lang.Object

com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

All Implemented Interfaces:

SitemeshBuffer

public class StringSitemeshBuffer
extends java.lang.Object
implements SitemeshBuffer

SitemeshBuffer that is a string

Constructor Summary

Constructors

Constructor and Description
StringSitemeshBuffer(java.lang.String buffer)

Method Summary

Modifier and Type	Method and Description
static SitemeshBufferFragment	createBufferFragment(java.lang.String buffer)
int	getBufferLength() Get the length of the buffered content.
char[]	getCharArray() Get the char array for this buffer.
SecondaryStorage	getSecondaryStorage()
int	getTotalLength() Get the total length of the buffered content, including the length of any chained buffers.
int	getTotalLength(int start, int length) Get the total length of the buffered content, including chained buffers from start to length
boolean	hasFragments() Whether the buffer has fragments or not
boolean	hasSecondaryStorage()
void	writeTo(java.io.Writer writer, int start, int length) Write this buffer, and any chained sub buffers in the given range, out to the given writer

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSitemeshBuffer

public StringSitemeshBuffer(java.lang.String buffer)

Method Detail

getCharArray

public char[] getCharArray()

Description copied from interface: SitemeshBuffer

Get the char array for this buffer. This array may be longer than the length of the content, you must use getBufferLength() in combination with this method.

Specified by:

getCharArray in interface SitemeshBuffer

Returns:

The char array for this buffer

getBufferLength

public int getBufferLength()

Description copied from interface: SitemeshBuffer

Get the length of the buffered content.

Specified by:

getBufferLength in interface SitemeshBuffer

Returns:

The length of the buffered content.

getTotalLength

public int getTotalLength()

Description copied from interface: SitemeshBuffer

Get the total length of the buffered content, including the length of any chained buffers.

Specified by:

getTotalLength in interface SitemeshBuffer

Returns:

The total length.

getTotalLength

public int getTotalLength(int start,
                          int length)

Description copied from interface: SitemeshBuffer

Get the total length of the buffered content, including chained buffers from start to length

Specified by:

getTotalLength in interface SitemeshBuffer

Parameters:

start - Where to start counting the length from

length - Where to finish

Returns:

THe total length in the given range

writeTo

public void writeTo(java.io.Writer writer,
                    int start,
                    int length)
             throws java.io.IOException

Description copied from interface: SitemeshBuffer

Write this buffer, and any chained sub buffers in the given range, out to the given writer

Specified by:

writeTo in interface SitemeshBuffer

Parameters:

writer - The writer to write to

start - The position to start writing from

length - The length to write

Throws:

java.io.IOException - If an error occurred

hasFragments

public boolean hasFragments()

Description copied from interface: SitemeshBuffer

Whether the buffer has fragments or not

Specified by:

hasFragments in interface SitemeshBuffer

Returns:

True if it has fragments

createBufferFragment

public static SitemeshBufferFragment createBufferFragment(java.lang.String buffer)

hasSecondaryStorage

public boolean hasSecondaryStorage()

Specified by:

hasSecondaryStorage in interface SitemeshBuffer

Returns:

if the buffer is backed by secondary storage

getSecondaryStorage

public SecondaryStorage getSecondaryStorage()

Specified by:

getSecondaryStorage in interface SitemeshBuffer

Returns:

the underlying secondary storage behind the page