Package cdc.issues

Class StructuredDescription.Builder<B extends StructuredDescription.Builder<B>>

java.lang.Object

cdc.issues.StructuredDescription.Builder<B>

Type Parameters:

B - The Builder type.

Direct Known Subclasses:

RuleDescription.Builder

Enclosing class:

StructuredDescription

public static class StructuredDescription.Builder<B extends StructuredDescription.Builder<B>>
extends Object

StructuredDescription builder.

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static String	INDENT	The indentation String.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
StructuredDescription	build()
B	header(String text)	Appends: text.
protected static String	indent(int level)
B	justification(int number, String justification)
B	justifications(String... justifications)
B	oItem(int level, int number, String item)	Adds 1 ordered list item at indentation level and with number.
B	oItem(int number, String item)	Adds 1 ordered list item at indentation level 0 and with number.
B	oItems(int level, int number, String... items)	Adds unordered list items at indentation level, starting at number.
B	oItems(int level, int number, Collection<String> items)	Adds unordered list items at indentation level, starting at number.
B	oItems(int number, String... items)	Adds unordered list items at indentation level 0, starting at number.
B	oItems(int number, Collection<String> items)	Adds unordered list items at indentation level °, starting at number.
B	section(String section)	Starts a section.
protected B	self()
B	text(String text)	Adds text to description.
B	uItem(int level, String item)	Adds 1 unordered list item at indentation level.
B	uItem(String item)	Adds 1 unordered list item at indentation level 0.
B	uItems(int level, String... items)	Adds unordered list items at indentation level.
B	uItems(int level, Collection<String> items)	Adds unordered list items at indentation level.
B	uItems(String... items)	Adds unordered list items at indentation level 0.
B	uItems(Collection<String> items)	Adds unordered list items at indentation level 0.
B	value(String value)
B	violation(String explanation)	Appends a violation explanation.

Methods inherited from class java.lang.Object

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

Field Detail

INDENT

public static final String INDENT

The indentation String.

See Also:

Constant Field Values

Constructor Detail

Builder

protected Builder()

Method Detail

indent

protected static String indent(int level)

self

protected B self()

text

public B text(String text)

Adds text to description.

Parameters:

text - The text to add.

Returns:

This builder.

header

public B header(String text)

Appends: text.

Parameters:

text - The header text.

Returns:

This Builder.

section

public B section(String section)

Starts a section.

Parameters:

section - The section title.

Returns:

This builder.

uItem

public B uItem(int level,
               String item)

Adds 1 unordered list item at indentation level.

Parameters:

level - The indentation level.

item - The list item.

Returns:

This builder.

uItem

public B uItem(String item)

Adds 1 unordered list item at indentation level 0.

Parameters:

item - The list item.

Returns:

This builder.

uItems

public B uItems(int level,
                String... items)

Adds unordered list items at indentation level.

Parameters:

level - The indentation level.

items - The list items.

Returns:

This builder.

uItems

public B uItems(String... items)

Adds unordered list items at indentation level 0.

Parameters:

items - The list items.

Returns:

This builder.

uItems

public B uItems(int level,
                Collection<String> items)

Adds unordered list items at indentation level.

Parameters:

level - The indentation level.

items - The list items.

Returns:

This builder.

uItems

public B uItems(Collection<String> items)

Adds unordered list items at indentation level 0.

Parameters:

items - The list items.

Returns:

This builder.

oItem

public B oItem(int level,
               int number,
               String item)

Adds 1 ordered list item at indentation level and with number.

Parameters:

level - The indentation level.

number - The number.

item - The list item.

Returns:

This builder.

oItem

public B oItem(int number,
               String item)

Adds 1 ordered list item at indentation level 0 and with number.

Parameters:

number - The number.

item - The list item.

Returns:

This builder.

oItems

public B oItems(int level,
                int number,
                String... items)

Adds unordered list items at indentation level, starting at number.

Parameters:

level - The indentation level.

number - The first number.

items - The list items.

Returns:

This builder.

oItems

public B oItems(int number,
                String... items)

Adds unordered list items at indentation level 0, starting at number.

Parameters:

number - The first number.

items - The list items.

Returns:

This builder.

oItems

public B oItems(int level,
                int number,
                Collection<String> items)

Adds unordered list items at indentation level, starting at number.

Parameters:

level - The indentation level.

number - The first number.

items - The list items.

Returns:

This builder.

oItems

public B oItems(int number,
                Collection<String> items)

Adds unordered list items at indentation level °, starting at number.

Parameters:

number - The first number.

items - The list items.

Returns:

This builder.

violation

public B violation(String explanation)

Appends a violation explanation.

Parameters:

explanation - The violation explanation.

Returns:

This Builder.

value

public B value(String value)

justification

public B justification(int number,
                       String justification)

justifications

public B justifications(String... justifications)

build

public StructuredDescription build()