net.steppschuh.markdowngenerator.list

Class ListBuilder

java.lang.Object

net.steppschuh.markdowngenerator.MarkdownBuilder<ListBuilder,UnorderedList>

net.steppschuh.markdowngenerator.list.ListBuilder

All Implemented Interfaces:

MarkdownSerializable

public class ListBuilder
extends MarkdownBuilder<ListBuilder,UnorderedList>

Created by steppschuh on 23/12/2016.

Field Summary

Fields inherited from class net.steppschuh.markdowngenerator.MarkdownBuilder

markdownElement, parentBuilder

Constructor Summary

Constructors

Constructor and Description
ListBuilder()
ListBuilder(MarkdownBuilder parentBuilder)

Method Summary

Modifier and Type	Method and Description
ListBuilder	append(MarkdownSerializable value) Attempts to serialize the specified value to markdown and appends it to the existing root MarkdownBuilder.markdownElement.
ListBuilder	append(java.lang.Object value) Attempts to append the specified value to the existing root MarkdownBuilder.markdownElement.
protected UnorderedList	createMarkdownElement() Creates the root element.
protected ListBuilder	getBuilder() Used for method chaining.

Methods inherited from class net.steppschuh.markdowngenerator.MarkdownBuilder

begin, beginCodeBlock, beginCodeBlock, beginList, beginQuote, bold, build, code, end, endsWithLineSeparators, getParentBuilder, heading, heading, image, image, italic, link, link, newLine, newLines, newLinesIfRequired, newParagraph, newParagraphIfRequired, progress, progressWithLabel, quote, rule, rule, setParentBuilder, strikeThrough, subHeading, taskList, text, toMarkdownElement, toString, unorderedList

Methods inherited from class java.lang.Object

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

Constructor Detail

ListBuilder

public ListBuilder()

ListBuilder

public ListBuilder(MarkdownBuilder parentBuilder)

Method Detail

getBuilder

protected ListBuilder getBuilder()

Description copied from class: MarkdownBuilder

Used for method chaining.

Specified by:

getBuilder in class MarkdownBuilder<ListBuilder,UnorderedList>

Returns:

the builder instance

createMarkdownElement

protected UnorderedList createMarkdownElement()

Description copied from class: MarkdownBuilder

Creates the root element. Typically without any content.

Specified by:

createMarkdownElement in class MarkdownBuilder<ListBuilder,UnorderedList>

Returns:

the root markdown element

append

public ListBuilder append(java.lang.Object value)

Description copied from class: MarkdownBuilder

Attempts to append the specified value to the existing root MarkdownBuilder.markdownElement.

Specified by:

append in class MarkdownBuilder<ListBuilder,UnorderedList>

Parameters:

value - value to be appended

Returns:

the builder instance

append

public ListBuilder append(MarkdownSerializable value)

Description copied from class: MarkdownBuilder

Attempts to serialize the specified value to markdown and appends it to the existing root MarkdownBuilder.markdownElement.

Overrides:

append in class MarkdownBuilder<ListBuilder,UnorderedList>

Parameters:

value - value to be appended

Returns:

the builder instance