com.opensymphony.module.sitemesh

Class SitemeshBufferFragment.Builder

java.lang.Object

com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Enclosing class:

SitemeshBufferFragment

public static class SitemeshBufferFragment.Builder
extends java.lang.Object

A builder for fragments.

Method Summary

Modifier and Type	Method and Description
SitemeshBufferFragment	build() Build the fragment
SitemeshBufferFragment.Builder	delete(int pos, int length) Delete length characters from pos in this buffer fragment
SitemeshBufferFragment.Builder	end(int pos) End the fragment
SitemeshBufferFragment.Builder	endDelete(int pos) End the current deletion
SitemeshBufferFragment.Builder	insert(int position, SitemeshBufferFragment fragment) Insert the given fragment to the given position
SitemeshBufferFragment.Builder	insert(int position, java.lang.String fragment) Insert the given string fragment to the given position
SitemeshBufferFragment.Builder	markStart(int pos) Mark the start of the fragment
SitemeshBufferFragment.Builder	markStartDelete(int pos) Mark the start of a deletion.
SitemeshBufferFragment.Builder	setBuffer(SitemeshBuffer sitemeshBuffer) Set the buffer.
SitemeshBufferFragment.Builder	setLength(int length)
SitemeshBufferFragment.Builder	setStart(int start)

Methods inherited from class java.lang.Object

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

Method Detail

setStart

public SitemeshBufferFragment.Builder setStart(int start)

setLength

public SitemeshBufferFragment.Builder setLength(int length)

delete

public SitemeshBufferFragment.Builder delete(int pos,
                                             int length)

Delete length characters from pos in this buffer fragment

Parameters:

pos - The position to delete from

length - The number of characters to delete

Returns:

The builder

markStart

public SitemeshBufferFragment.Builder markStart(int pos)

Mark the start of the fragment

Parameters:

pos - The start of the fragment

Returns:

The builder

end

public SitemeshBufferFragment.Builder end(int pos)

End the fragment

Parameters:

pos - The position of the end of the fragment

Returns:

The builder

markStartDelete

public SitemeshBufferFragment.Builder markStartDelete(int pos)

Mark the start of a deletion.

Parameters:

pos - The position to start deleting from

Returns:

The builder

Throws:

java.lang.IllegalStateException - If markStartDelete() has already been called and endDelete() hasn't been called

endDelete

public SitemeshBufferFragment.Builder endDelete(int pos)

End the current deletion

Parameters:

pos - The position to delete to

Returns:

The builder

Throws:

java.lang.IllegalStateException - If markStartDelete() hasn't been called

insert

public SitemeshBufferFragment.Builder insert(int position,
                                             SitemeshBufferFragment fragment)

Insert the given fragment to the given position

Parameters:

position - The position to insert the fragment to

fragment - The fragment to insert

Returns:

The builder

insert

public SitemeshBufferFragment.Builder insert(int position,
                                             java.lang.String fragment)

Insert the given string fragment to the given position

Parameters:

position - The position to insert at

fragment - The fragment to insert

Returns:

The builder

setBuffer

public SitemeshBufferFragment.Builder setBuffer(SitemeshBuffer sitemeshBuffer)

Set the buffer. This resets both start and length to be that of the buffer.

Parameters:

sitemeshBuffer - The buffer to set.

Returns:

The builder

build

public SitemeshBufferFragment build()

Build the fragment

Returns:

The built fragment