nl.flotsam.pecia.builder.base
Class DefaultEntryBuilder<T>

java.lang.Object
  nl.flotsam.pecia.builder.base.AbstractBuilder<T>
      nl.flotsam.pecia.builder.base.DefaultEntryBuilder<T>

All Implemented Interfaces:

EntryBuilder<T>, Initializer<EntryBuilder<T>>, DocumentElement<T>, Entry<T>, SimpleContents<Entry<T>>

Direct Known Subclasses:

HtmlDocumentBuilder.HtmlColBuilder

public class DefaultEntryBuilder<T>
extends AbstractBuilder<T>
implements EntryBuilder<T>

Constructor Summary

DefaultEntryBuilder(DocumentBuilder builder, T parent, boolean header, LifecycleListener listener)

Method Summary

Entry<T>	document(Documenter<SimpleContents<?>> target) Generates documentation, and returns the current context.
T	entry() Creates the next table cell entry.
boolean	isHeader()
ItemizedList<? extends Entry<T>>	itemizedList() Adds an itemized list.
ItemizedList<? extends Entry<T>>	orderedList() Adds an ordered list.
Para<? extends Entry<T>>	para() Creates a paragraph.
Entry<T>	para(String text) Adds a new paragraph containing just the text passed in.
EntryBuilder<T>	start()
Table2Cols<? extends Entry<T>>	table2Cols() Adds a two-column table.
Table3Cols<? extends Entry<T>>	table3Cols() Adds a three-column table.
Table4Cols<? extends Entry<T>>	table4Cols() Adds a four-column table.
Table5Cols<? extends Entry<T>>	table5Cols() Adds a five-column table.
Verbatim<? extends Entry<T>>	verbatim() Adds verbatim content.

Methods inherited from class nl.flotsam.pecia.builder.base.AbstractBuilder

end, getBuilder, getListener, getParent

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEntryBuilder

public DefaultEntryBuilder(DocumentBuilder builder,
                           T parent,
                           boolean header,
                           LifecycleListener listener)

Method Detail

entry

public T entry()

Description copied from interface: Entry

Creates the next table cell entry.

Specified by:

entry in interface Entry<T>

Returns:

The new table cell entry.

para

public Para<? extends Entry<T>> para()

Description copied from interface: Entry

Creates a paragraph.

Specified by:

para in interface Entry<T>

Specified by:

para in interface SimpleContents<Entry<T>>

Returns:

A paragraph embedded in the table cell.

isHeader

public boolean isHeader()

start

public EntryBuilder<T> start()

Specified by:

start in interface Initializer<EntryBuilder<T>>

para

public Entry<T> para(String text)

Description copied from interface: Entry

Adds a new paragraph containing just the text passed in.

Specified by:

para in interface Entry<T>

Specified by:

para in interface SimpleContents<Entry<T>>

Parameters:

text - The text to be added to the paragraph.

Returns:

The current context.

itemizedList

public ItemizedList<? extends Entry<T>> itemizedList()

Description copied from interface: SimpleContents

Adds an itemized list.

Specified by:

itemizedList in interface SimpleContents<Entry<T>>

Returns:

The itemized list just created.

orderedList

public ItemizedList<? extends Entry<T>> orderedList()

Description copied from interface: SimpleContents

Adds an ordered list.

Specified by:

orderedList in interface SimpleContents<Entry<T>>

Returns:

The ordered list just created.

table2Cols

public Table2Cols<? extends Entry<T>> table2Cols()

Description copied from interface: SimpleContents

Adds a two-column table.

Specified by:

table2Cols in interface SimpleContents<Entry<T>>

Returns:

A two column table.

table3Cols

public Table3Cols<? extends Entry<T>> table3Cols()

Description copied from interface: SimpleContents

Adds a three-column table.

Specified by:

table3Cols in interface SimpleContents<Entry<T>>

Returns:

A three column table.

table4Cols

public Table4Cols<? extends Entry<T>> table4Cols()

Description copied from interface: SimpleContents

Adds a four-column table.

Specified by:

table4Cols in interface SimpleContents<Entry<T>>

Returns:

A four column table.

table5Cols

public Table5Cols<? extends Entry<T>> table5Cols()

Description copied from interface: SimpleContents

Adds a five-column table.

Specified by:

table5Cols in interface SimpleContents<Entry<T>>

Returns:

A five column table.

verbatim

public Verbatim<? extends Entry<T>> verbatim()

Description copied from interface: SimpleContents

Adds verbatim content.

Specified by:

verbatim in interface SimpleContents<Entry<T>>

Returns:

The object representing verbatim content.

document

public Entry<T> document(Documenter<SimpleContents<?>> target)

Description copied from interface: SimpleContents

Generates documentation, and returns the current context.

Specified by:

document in interface SimpleContents<Entry<T>>

Parameters:

target - The object generating the documentation.