Package com.opensymphony.module.sitemesh

Class DefaultSitemeshBuffer

java.lang.Object

com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

All Implemented Interfaces:

SitemeshBuffer

public class DefaultSitemeshBuffer
extends Object
implements SitemeshBuffer

The default implementation of sitemesh buffer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultSitemeshBuffer.Builder	The Class Builder.

Constructor Summary

Constructors

Constructor	Description
DefaultSitemeshBuffer(char[] buffer)	Instantiates a new default sitemesh buffer.
DefaultSitemeshBuffer(char[] buffer, int length)	Instantiates a new default sitemesh buffer.
DefaultSitemeshBuffer(char[] buffer, int length, TreeMap<Integer,SitemeshBufferFragment> bufferFragments)	Instantiates a new default sitemesh buffer.

Method Summary

Modifier and Type	Method	Description
static DefaultSitemeshBuffer.Builder	builder()	Builder.
static DefaultSitemeshBuffer.Builder	builder(SitemeshBuffer sitemeshBuffer)	Builder.
int	getBufferLength()	Get the length of the buffered content.
char[]	getCharArray()	Get the char array for this buffer.
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.
void	writeTo(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 Details

DefaultSitemeshBuffer

public DefaultSitemeshBuffer(char[] buffer)

Instantiates a new default sitemesh buffer.

Parameters:

buffer - the buffer

DefaultSitemeshBuffer

public DefaultSitemeshBuffer(char[] buffer,
 int length)

Instantiates a new default sitemesh buffer.

Parameters:

buffer - the buffer

length - the length

DefaultSitemeshBuffer

public DefaultSitemeshBuffer(char[] buffer,
 int length,
 TreeMap<Integer,SitemeshBufferFragment> bufferFragments)

Instantiates a new default sitemesh buffer.

Parameters:

buffer - the buffer

length - the length

bufferFragments - the buffer fragments

Method Details

writeTo

public void writeTo(Writer writer,
 int start,
 int length)
             throws 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:

IOException - If an error occurred

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

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.

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

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

builder

public static DefaultSitemeshBuffer.Builder builder()

Builder.

Returns:

the builder

builder

public static DefaultSitemeshBuffer.Builder builder(SitemeshBuffer sitemeshBuffer)

Builder.

Parameters:

sitemeshBuffer - the sitemesh buffer

Returns:

the builder