MarkdownBuilder (MarkdownGenerator 1.3.2 API)

java.lang.Object
- net.steppschuh.markdowngenerator.MarkdownBuilder<T,S>

All Implemented Interfaces:

MarkdownSerializable

Direct Known Subclasses:

CodeBlockBuilder, ListBuilder, QuoteBuilder, TextBuilder
```
public abstract class MarkdownBuilder<T extends MarkdownBuilder<T,S>,S extends MarkdownElement>
extends java.lang.Object
implements MarkdownSerializable
```
Base class that every markdown builder extends. Basically capable of appending stuff to a root MarkdownElement.

Field Summary

Fields
Modifier and Type	Field and Description
`protected S`	`markdownElement` The root element that content will be appended too.
`protected MarkdownBuilder`	`parentBuilder` The parent markdown builder, if available.

Constructor Summary

Constructors
Modifier Constructor and Description

MarkdownBuilder()

protected MarkdownBuilder(MarkdownBuilder parentBuilder)

Constructors
Modifier	Constructor and Description
	`MarkdownBuilder()`
`protected`	`MarkdownBuilder(MarkdownBuilder parentBuilder)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`append(MarkdownSerializable value)` Attempts to serialize the specified value to markdown and appends it to the existing root `markdownElement`.
`abstract T`	`append(java.lang.Object value)` Attempts to append the specified value to the existing root `markdownElement`.
`MarkdownBuilder`	`begin(MarkdownBuilder markdownBuilder)` All chained method calls will be called on the passed 'child' builder until `end()` will be called.
`CodeBlockBuilder`	`beginCodeBlock()` Creates a new `CodeBlockBuilder` instance.
`CodeBlockBuilder`	`beginCodeBlock(java.lang.String language)` Creates a new `CodeBlockBuilder` instance and sets the language.
`ListBuilder`	`beginList()` Creates a new `ListBuilder` instance.
`QuoteBuilder`	`beginQuote()` Creates a new `QuoteBuilder` instance.
`T`	`bold(java.lang.Object value)` Appends a `BoldText` element to the root `markdownElement`.
`S`	`build()` Returns the root `markdownElement`
`T`	`code(java.lang.Object value)` Appends a `Code` element to the root `markdownElement`.
`protected abstract S`	`createMarkdownElement()` Creates the root element.
`MarkdownBuilder`	`end()` If a `parentBuilder` is set (e.g.
`protected boolean`	`endsWithLineSeparators(int count)` Checks if the root `markdownElement` ends with the specified number of new lines
`protected abstract T`	`getBuilder()` Used for method chaining.
`MarkdownBuilder`	`getParentBuilder()`
`T`	`heading(java.lang.String value)` Appends a `Heading` element with level 1 to the root `markdownElement`.
`T`	`heading(java.lang.String value, int level)` Appends a `Heading` element to the root `markdownElement`.
`T`	`image(java.lang.String url)` Appends an `Image` element to the root `markdownElement`.
`T`	`image(java.lang.String text, java.lang.String url)` Appends an `Image` element to the root `markdownElement`.
`T`	`italic(java.lang.Object value)` Appends an `ItalicText` element to the root `markdownElement`.
`T`	`link(java.lang.String url)` Appends a `Link` element to the root `markdownElement`.
`T`	`link(java.lang.String text, java.lang.String url)` Appends a `Link` element to the root `markdownElement`.
`T`	`newLine()` Appends a new line to the existing root `markdownElement`.
`T`	`newLines(int count)` Appends a new line to the existing root `markdownElement` if it not already ends with a new line.
`protected T`	`newLinesIfRequired(int count)` Appends the specified number of new lines to the existing root `markdownElement` if it not already ends with a new line.
`T`	`newParagraph()` Appends two new lines to the existing root `markdownElement`.
`protected T`	`newParagraphIfRequired()` Appends two new lines to the existing root `markdownElement` if it not already ends with two new lines.
`T`	`progress(double progress)` Appends a `ProgressBar` element to the root `markdownElement`.
`T`	`progressWithLabel(double progress)` Appends a `ProgressBar` element with a value label to the root `markdownElement`.
`T`	`quote(java.lang.String value)` Appends a `Quote` element to the root `markdownElement`.
`T`	`rule()` Appends a `HorizontalRule` element to the root `markdownElement`.
`T`	`rule(int length)` Appends a `HorizontalRule` element to the root `markdownElement`.
`void`	`setParentBuilder(MarkdownBuilder parentBuilder)`
`T`	`strikeThrough(java.lang.Object value)` Appends a `StrikeThroughText` element to the root `markdownElement`.
`T`	`subHeading(java.lang.String value)` Appends a `Heading` element with level 2 to the root `markdownElement`.
`T`	`taskList(TaskListItem... items)` Appends a `TaskList` element to the root `markdownElement`.
`T`	`text(java.lang.Object value)` Appends a normal `Text` element to the root `markdownElement`.
`MarkdownElement`	`toMarkdownElement()`
`java.lang.String`	`toString()`
`T`	`unorderedList(java.lang.Object... items)` Appends a `UnorderedList` element to the root `markdownElement`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - markdownElement
```
protected S extends MarkdownElement markdownElement
```
    The root element that content will be appended too.
  - parentBuilder
```
protected MarkdownBuilder parentBuilder
```
    The parent markdown builder, if available. Parent builder will be set in child builders, if they have been created using the begin(MarkdownBuilder) method. If set, this will be returned in the end() method.
- Constructor Detail
  - MarkdownBuilder
```
public MarkdownBuilder()
```
  - MarkdownBuilder
```
protected MarkdownBuilder(MarkdownBuilder parentBuilder)
```
- Method Detail
  - getBuilder
```
protected abstract T getBuilder()
```
    Used for method chaining.
    
    Returns:
    
    the builder instance
  - createMarkdownElement
```
protected abstract S createMarkdownElement()
```
    Creates the root element. Typically without any content.
    
    Returns:
    
    the root markdown element
  - begin
```
public MarkdownBuilder begin(MarkdownBuilder markdownBuilder)
```
    All chained method calls will be called on the passed 'child' builder until end() will be called.
    
    Parameters:
    
    markdownBuilder - the new builder which should be used
    
    Returns:
    
    the passed markdown builder
  - end
```
public MarkdownBuilder end()
```
    If a parentBuilder is set (e.g. if begin(MarkdownBuilder) was called before), the current markdownElement will be appended to the parent builder, which will also be returned.
    
    Returns:
    
    the parent builder
  - text
```
public T text(java.lang.Object value)
```
    Appends a normal Text element to the root markdownElement.
    
    Parameters:
    
    value - value for the new element
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Text.Text(Object)
  - bold
```
public T bold(java.lang.Object value)
```
    Appends a BoldText element to the root markdownElement.
    
    Parameters:
    
    value - value for the new element
    
    Returns:
    
    the builder instance
    
    See Also:
    
    BoldText.BoldText(Object)
  - italic
```
public T italic(java.lang.Object value)
```
    Appends an ItalicText element to the root markdownElement.
    
    Parameters:
    
    value - value for the new element
    
    Returns:
    
    the builder instance
    
    See Also:
    
    ItalicText.ItalicText(Object)
  - strikeThrough
```
public T strikeThrough(java.lang.Object value)
```
    Appends a StrikeThroughText element to the root markdownElement.
    
    Parameters:
    
    value - value for the new element
    
    Returns:
    
    the builder instance
    
    See Also:
    
    StrikeThroughText.StrikeThroughText(Object)
  - heading
```
public T heading(java.lang.String value,
                 int level)
```
    Appends a Heading element to the root markdownElement.
    
    Parameters:
    
    value - value for the new element
    
    level - the heading level
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Heading.Heading(Object, int)
  - heading
```
public T heading(java.lang.String value)
```
    Appends a Heading element with level 1 to the root markdownElement.
    
    Parameters:
    
    value - value for the new element
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Heading.Heading(Object, int)
  - subHeading
```
public T subHeading(java.lang.String value)
```
    Appends a Heading element with level 2 to the root markdownElement.
    
    Parameters:
    
    value - value for the new element
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Heading.Heading(Object, int)
  - rule
```
public T rule()
```
    Appends a HorizontalRule element to the root markdownElement.
    
    Returns:
    
    the builder instance
    
    See Also:
    
    HorizontalRule.HorizontalRule()
  - rule
```
public T rule(int length)
```
    Appends a HorizontalRule element to the root markdownElement.
    
    Returns:
    
    the builder instance
    
    See Also:
    
    HorizontalRule.HorizontalRule(int)
  - link
```
public T link(java.lang.String text,
              java.lang.String url)
```
    Appends a Link element to the root markdownElement.
    
    Parameters:
    
    text - text for the link
    
    url - url for the link
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Link.Link(Object, String)
  - link
```
public T link(java.lang.String url)
```
    Appends a Link element to the root markdownElement.
    
    Parameters:
    
    url - url for the link
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Link.Link(String)
  - image
```
public T image(java.lang.String text,
               java.lang.String url)
```
    Appends an Image element to the root markdownElement.
    
    Parameters:
    
    text - text for the image
    
    url - url to the image
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Image.Image(Object, String)
  - image
```
public T image(java.lang.String url)
```
    Appends an Image element to the root markdownElement.
    
    Parameters:
    
    url - url to the image
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Image.Image(String)
  - progress
```
public T progress(double progress)
```
    Appends a ProgressBar element to the root markdownElement.
    
    Parameters:
    
    progress - progress value ranging from 0 to 1
    
    Returns:
    
    the builder instance
    
    See Also:
    
    ProgressBar.ProgressBar(double)
  - progressWithLabel
```
public T progressWithLabel(double progress)
```
    Appends a ProgressBar element with a value label to the root markdownElement.
    
    Parameters:
    
    progress - progress value ranging from 0 to 1
    
    Returns:
    
    the builder instance
    
    See Also:
    
    ProgressBar.ProgressBar(double)
  - beginQuote
```
public QuoteBuilder beginQuote()
```
    Creates a new QuoteBuilder instance.
    
    Returns:
    
    a new child builder instance
    
    See Also:
    
    QuoteBuilder.QuoteBuilder(MarkdownBuilder)
  - quote
```
public T quote(java.lang.String value)
```
    Appends a Quote element to the root markdownElement.
    
    Parameters:
    
    value - value for the element
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Quote.Quote(Object)
  - beginCodeBlock
```
public CodeBlockBuilder beginCodeBlock(java.lang.String language)
```
    Creates a new CodeBlockBuilder instance and sets the language.
    
    Parameters:
    
    language - the code language for syntax highlighting
    
    Returns:
    
    a new child builder instance
    
    See Also:
    
    CodeBlockBuilder.CodeBlockBuilder(MarkdownBuilder, String)
  - beginCodeBlock
```
public CodeBlockBuilder beginCodeBlock()
```
    Creates a new CodeBlockBuilder instance.
    
    Returns:
    
    a new child builder instance
    
    See Also:
    
    CodeBlockBuilder.CodeBlockBuilder(MarkdownBuilder)
  - code
```
public T code(java.lang.Object value)
```
    Appends a Code element to the root markdownElement.
    
    Parameters:
    
    value - value for the new element
    
    Returns:
    
    the builder instance
    
    See Also:
    
    Code.Code(Object)
  - beginList
```
public ListBuilder beginList()
```
    Creates a new ListBuilder instance.
    
    Returns:
    
    a new child builder instance
    
    See Also:
    
    ListBuilder.ListBuilder(MarkdownBuilder)
  - unorderedList
```
public T unorderedList(java.lang.Object... items)
```
    Appends a UnorderedList element to the root markdownElement.
    
    Parameters:
    
    items - elements that should be list items
    
    Returns:
    
    the builder instance
    
    See Also:
    
    UnorderedList.UnorderedList(List)
  - taskList
```
public T taskList(TaskListItem... items)
```
    Appends a TaskList element to the root markdownElement.
    
    Parameters:
    
    items - elements that should be task items
    
    Returns:
    
    the builder instance
    
    See Also:
    
    TaskList.TaskList(List)
  - append
```
public abstract T append(java.lang.Object value)
```
    Attempts to append the specified value to the existing root markdownElement.
    
    Parameters:
    
    value - value to be appended
    
    Returns:
    
    the builder instance
  - append
```
public T append(MarkdownSerializable value)
```
    Attempts to serialize the specified value to markdown and appends it to the existing root markdownElement.
    
    Parameters:
    
    value - value to be appended
    
    Returns:
    
    the builder instance
  - newParagraph
```
public T newParagraph()
```
    Appends two new lines to the existing root markdownElement.
    
    Returns:
    
    the builder instance
  - newParagraphIfRequired
```
protected T newParagraphIfRequired()
```
    Appends two new lines to the existing root markdownElement if it not already ends with two new lines.
    
    Returns:
    
    the builder instance
  - newLine
```
public T newLine()
```
    Appends a new line to the existing root markdownElement.
    
    Returns:
    
    the builder instance
  - newLines
```
public T newLines(int count)
```
    Appends a new line to the existing root markdownElement if it not already ends with a new line.
    
    Returns:
    
    the builder instance
  - newLinesIfRequired
```
protected T newLinesIfRequired(int count)
```
    Appends the specified number of new lines to the existing root markdownElement if it not already ends with a new line.
    
    Parameters:
    
    count - number of new lines to be appended
    
    Returns:
    
    the builder instance
  - endsWithLineSeparators
```
protected boolean endsWithLineSeparators(int count)
```
    Checks if the root markdownElement ends with the specified number of new lines
    
    Parameters:
    
    count - number of new lines
    
    Returns:
    
    true if it ends with the specified number of new lines
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toMarkdownElement
```
public MarkdownElement toMarkdownElement()
                                  throws MarkdownSerializationException
```
    Specified by:
    
    toMarkdownElement in interface MarkdownSerializable
    
    Throws:
    
    MarkdownSerializationException
  - build
```
public S build()
```
    Returns the root markdownElement
    
    Returns:
    
    markdownElement
  - getParentBuilder
```
public MarkdownBuilder getParentBuilder()
```
  - setParentBuilder
```
public void setParentBuilder(MarkdownBuilder parentBuilder)
```

Class MarkdownBuilder<T extends MarkdownBuilder<T,S>,S extends MarkdownElement>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

markdownElement

parentBuilder

Constructor Detail

MarkdownBuilder

MarkdownBuilder

Method Detail

getBuilder

createMarkdownElement

begin

end

text

bold

italic

strikeThrough

heading

heading

subHeading

rule

rule

link

link

image

image

progress

progressWithLabel

beginQuote

quote

beginCodeBlock

beginCodeBlock

code

beginList

unorderedList

taskList

append

append

newParagraph

newParagraphIfRequired

newLine

newLines

newLinesIfRequired

endsWithLineSeparators

toString

toMarkdownElement

build

getParentBuilder

setParentBuilder