Index (JavaMarkdown 0.0.37 API)

A B C F G H I L M N O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

add(Object...) - Method in class org.tealeaf.javamarkdown.types.ListStructure: Adds objects to the end of the list.
add(Stream<?>) - Method in class org.tealeaf.javamarkdown.types.ListStructure: Adds objects to the end of the list.
addRows(Object[]...) - Method in class org.tealeaf.javamarkdown.elements.Table: Adds rows of content to the table
append(Object) - Method in class org.tealeaf.javamarkdown.MarkdownBuffer: Appends any given object to the end of the document.
append(Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Appends any given object to the end of the document.
appendBold(Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Displays provided content as bold.
appendBulletList(Object[]) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendBulletList(String, Object[]) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendBulletList(String, List<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendBulletList(String, Stream<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendBulletList(List<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendBulletList(Stream<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendCode(Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Displays provided content as short code snippets
appendCodeBlock(Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Displays a block of code
appendCodeBlock(String, Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Displays a block of code with syntax highlighting
appendHeader(int, Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendHeader(Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendImage(String) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendImage(String, String) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendItalic(Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Appends text to the end of the compiler formatted as italics
appendLink(Object, String) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendLink(String) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendMarkdownBuffer(MarkdownBuffer) - Method in class org.tealeaf.javamarkdown.MarkdownBuffer: Unpacks another markdown buffer and appends each item to the end of the list
appendMarkdownElement(MarkdownElement) - Method in class org.tealeaf.javamarkdown.MarkdownBuffer: Appends a markdown element to the end of the document.
appendMarkdownElement(MarkdownElement) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Appends a markdown element to the end of the document.
appendMarkdownElement(MarkdownElement) - Method in class org.tealeaf.javamarkdown.MarkdownWriter
appendNumberedList(int, Object[]) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(int, List<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(int, Stream<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(Object[]) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(String, int, Object[]) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(String, int, List<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(String, int, Stream<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(String, Object[]) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(String, List<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(String, Stream<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(List<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendNumberedList(Stream<?>) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendStrikethrough(Object) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Appends content formatted as struck out
appendString(String) - Method in class org.tealeaf.javamarkdown.MarkdownBuffer: Appends a string to the end of the document.
appendString(String) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler: Appends a string to the end of the document.
appendString(String) - Method in class org.tealeaf.javamarkdown.MarkdownWriter: Writes a string to the writer
appendTable(Object[], Object[][]) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
appendTable(Object[], Table.Alignment[], Object[][]) - Method in interface org.tealeaf.javamarkdown.MarkdownCompiler
asString() - Method in class org.tealeaf.javamarkdown.elements.CodeBlock: Formats the element to a string
asString() - Method in class org.tealeaf.javamarkdown.elements.Header: Formats the element to a string
asString() - Method in class org.tealeaf.javamarkdown.elements.Image: Formats the string into the link syntax used in Markdown
asString() - Method in class org.tealeaf.javamarkdown.elements.Link: Formats the string into the link syntax used in Markdown
asString() - Method in class org.tealeaf.javamarkdown.elements.Table: Formats the element to a string
asString() - Method in class org.tealeaf.javamarkdown.MarkdownElement: Formats the element to a string
asString() - Method in class org.tealeaf.javamarkdown.types.ListStructure: Formats the element to a string
asString() - Method in class org.tealeaf.javamarkdown.types.Markup: Formats the element to a string
asString(boolean) - Method in class org.tealeaf.javamarkdown.MarkdownElement: Formats the element to a string, including required new-lines as needed

B

Bold - Class in org.tealeaf.javamarkdown.elements: Renders a section of text in markdown as bold.
Bold(Object) - Constructor for class org.tealeaf.javamarkdown.elements.Bold: Creates a new bold section of text.
BulletList - Class in org.tealeaf.javamarkdown.elements: Implements a bulleted list
BulletList() - Constructor for class org.tealeaf.javamarkdown.elements.BulletList: Creates an empty bullet list with no name
BulletList(Object[]) - Constructor for class org.tealeaf.javamarkdown.elements.BulletList: Creates a bullet list with an initial set of items and no name
BulletList(String) - Constructor for class org.tealeaf.javamarkdown.elements.BulletList: Creates an empty list with a name
BulletList(String, Object[]) - Constructor for class org.tealeaf.javamarkdown.elements.BulletList: Creates a list with initial contents and a set name
BulletList(String, List<?>) - Constructor for class org.tealeaf.javamarkdown.elements.BulletList: Creates a list with a set name and initial contents from a list
BulletList(String, Stream<?>) - Constructor for class org.tealeaf.javamarkdown.elements.BulletList: Creates a list with a name and initial contents from a stream
BulletList(List<?>) - Constructor for class org.tealeaf.javamarkdown.elements.BulletList: Creates a list with initial contents from a list
BulletList(Stream<?>) - Constructor for class org.tealeaf.javamarkdown.elements.BulletList: Creates a list with initial contents from a stream

C

CENTER - Enum constant in enum class org.tealeaf.javamarkdown.elements.Table.Alignment: Aligns all text to the center of the cell.
checkType(T) - Method in class org.tealeaf.javamarkdown.elements.Code: Checks the type of a passed object.
checkType(T) - Method in class org.tealeaf.javamarkdown.elements.Link: Checks the type of a passed object.
checkType(T) - Method in class org.tealeaf.javamarkdown.MarkdownElement: Checks the type of a passed object.
checkType(T) - Method in class org.tealeaf.javamarkdown.types.InlineElement: Checks the type of a passed object.
checkType(T) - Method in class org.tealeaf.javamarkdown.types.ListStructure: Checks the type of a passed object.
checkType(T) - Method in class org.tealeaf.javamarkdown.types.Structure: Checks the type of a passed object.
close() - Method in class org.tealeaf.javamarkdown.MarkdownWriter
Code - Class in org.tealeaf.javamarkdown.elements: Prints out inline-text as a small code snippet, such as This.
Code(Object) - Constructor for class org.tealeaf.javamarkdown.elements.Code: Creates a code snippet with the provided content
CodeBlock - Class in org.tealeaf.javamarkdown.elements: An element that displays its contents within a code block.
CodeBlock(Object) - Constructor for class org.tealeaf.javamarkdown.elements.CodeBlock: Creates a code block with the provided content
CodeBlock(String, Object) - Constructor for class org.tealeaf.javamarkdown.elements.CodeBlock: Creates a code block with the provided content and a given language

F

flush() - Method in class org.tealeaf.javamarkdown.MarkdownWriter

G

getAlignment() - Method in enum class org.tealeaf.javamarkdown.elements.Table.Alignment: Returns the printed text for this alignment
getItems() - Method in class org.tealeaf.javamarkdown.types.ListStructure: Gets the currnet list of items
getLastChar() - Method in class org.tealeaf.javamarkdown.MarkdownWriter
getMessage() - Method in exception class org.tealeaf.javamarkdown.exceptions.IllegalAlignmentCountException
getMessage() - Method in exception class org.tealeaf.javamarkdown.exceptions.IllegalContentsException: Returns the detail message string of this throwable.
getName() - Method in class org.tealeaf.javamarkdown.types.ListStructure: Gets the current set name of the list structure
getPrefix(int) - Method in class org.tealeaf.javamarkdown.elements.BulletList: Generates the prefix to insert before a given item in the list.
getPrefix(int) - Method in class org.tealeaf.javamarkdown.elements.NumberedList: Generates the prefix to insert before a given item in the list.
getPrefix(int) - Method in class org.tealeaf.javamarkdown.types.ListStructure: Generates the prefix to insert before a given item in the list.
getStart() - Method in class org.tealeaf.javamarkdown.elements.NumberedList
getWriter() - Method in class org.tealeaf.javamarkdown.MarkdownWriter: Gets the writer used to handle core functionality

H

Header - Class in org.tealeaf.javamarkdown.elements: Represents a header in a markdown document.
Header(int, Object) - Constructor for class org.tealeaf.javamarkdown.elements.Header: Creates a new header of a specified level.
Header(Object) - Constructor for class org.tealeaf.javamarkdown.elements.Header: Creates a new level-1 header

I

IllegalAlignmentCountException - Exception Class in org.tealeaf.javamarkdown.exceptions: When thrown, indicates that the number of alignments passed into a table did not match the number of headers
IllegalAlignmentCountException(int, int) - Constructor for exception class org.tealeaf.javamarkdown.exceptions.IllegalAlignmentCountException: Creates a new IllegalAlignmentCountException with the expected count and the actual count
IllegalContentsException - Exception Class in org.tealeaf.javamarkdown.exceptions: When thrown, indicates that an illegal element was attempted to be passed as content of another element.
IllegalContentsException(Class<?>) - Constructor for exception class org.tealeaf.javamarkdown.exceptions.IllegalContentsException: Creates a new IllegalContents exception with the illegal class in question
IllegalHeaderLevelException - Exception Class in org.tealeaf.javamarkdown.exceptions: Indicates that an illegal header level was passed into the Header class
IllegalHeaderLevelException(int) - Constructor for exception class org.tealeaf.javamarkdown.exceptions.IllegalHeaderLevelException: Creates a new IllegalHeaderLevelException with a specified level
Image - Class in org.tealeaf.javamarkdown.elements: Displays an image within the document.
Image(String) - Constructor for class org.tealeaf.javamarkdown.elements.Image: Implements an image with no alt text.
Image(String, String) - Constructor for class org.tealeaf.javamarkdown.elements.Image
InlineElement - Class in org.tealeaf.javamarkdown.types: A base type for any element that can be inserted within a sentence, such as simple markups or similar items.
InlineElement() - Constructor for class org.tealeaf.javamarkdown.types.InlineElement
Italic - Class in org.tealeaf.javamarkdown.elements: Renders some content in Italics
Italic(Object) - Constructor for class org.tealeaf.javamarkdown.elements.Italic: Creates an Italics object, and sets the content to be rendered in italics
items - Variable in class org.tealeaf.javamarkdown.MarkdownBuffer
items - Variable in class org.tealeaf.javamarkdown.types.ListStructure: List of objects to print, in order that they are printed

L

LEFT - Enum constant in enum class org.tealeaf.javamarkdown.elements.Table.Alignment: Aligns all text to the left in the cell.
Link - Class in org.tealeaf.javamarkdown.elements: Creates a clickable link in the Markdown Document.
Link(Object, String) - Constructor for class org.tealeaf.javamarkdown.elements.Link: Creates a link with the specified display and the url it links to
Link(String) - Constructor for class org.tealeaf.javamarkdown.elements.Link: Creates a simple link that displays the same url that it links to
ListStructure - Class in org.tealeaf.javamarkdown.types: Abstract structure that represents an element that lists elements in a list-like structure
ListStructure() - Constructor for class org.tealeaf.javamarkdown.types.ListStructure: Creates an empty list with no name
ListStructure(Object[]) - Constructor for class org.tealeaf.javamarkdown.types.ListStructure: Creates a list with initial contents and no name
ListStructure(String) - Constructor for class org.tealeaf.javamarkdown.types.ListStructure: Creates an empty list with a name
ListStructure(String, Object[]) - Constructor for class org.tealeaf.javamarkdown.types.ListStructure: Creates a list with initial contents and a set name
ListStructure(String, List<?>) - Constructor for class org.tealeaf.javamarkdown.types.ListStructure: Creates a list with initial contents and a set name
ListStructure(String, Stream<?>) - Constructor for class org.tealeaf.javamarkdown.types.ListStructure: Creates a list with initial contents and a set name.
ListStructure(List<?>) - Constructor for class org.tealeaf.javamarkdown.types.ListStructure: Creates a list with initial contents and no name
ListStructure(Stream<?>) - Constructor for class org.tealeaf.javamarkdown.types.ListStructure: Creates a list with initial contents and no name.

M

MarkdownBuffer - Class in org.tealeaf.javamarkdown: A MarkdownCompiler that first takes all objects passed in and compiles it to an array, only rendering them when requested.
MarkdownBuffer() - Constructor for class org.tealeaf.javamarkdown.MarkdownBuffer
MarkdownCompiler<T extends MarkdownCompiler<?>> - Interface in org.tealeaf.javamarkdown: Implements methods used within any markdown compiler.
MarkdownElement - Class in org.tealeaf.javamarkdown: Represents a markdown item, or component, that contains its own method of printing itself.
MarkdownElement() - Constructor for class org.tealeaf.javamarkdown.MarkdownElement
MarkdownWriter - Class in org.tealeaf.javamarkdown: A builder, or writer, that implements methods for appending markdown elements, as well as the ability to directly append markdown elements
MarkdownWriter() - Constructor for class org.tealeaf.javamarkdown.MarkdownWriter: Creates a new MarkdownWriter, using a new StringWriter to handle the writing functionality.
MarkdownWriter(Writer) - Constructor for class org.tealeaf.javamarkdown.MarkdownWriter: Creates a new MarkdownBuilder with a preset Writer.
Markup - Class in org.tealeaf.javamarkdown.types: Represents markdown elements that indicates a simple markup syntax to the content text, such as **words** to indicate bold text.
Markup(Object, String) - Constructor for class org.tealeaf.javamarkdown.types.Markup: Creates a new markup element with a content object and the wrapping syntax

N

name - Variable in class org.tealeaf.javamarkdown.types.ListStructure: Name to print before printing the list
NumberedList - Class in org.tealeaf.javamarkdown.elements: Implements a numbered list.
NumberedList() - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList: Creates an empty list with no name.
NumberedList(int) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList: Creates an empty list with no name and a set starting digit.
NumberedList(int, Object[]) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList: Creates a list with a set starting index and initial objects
NumberedList(int, List<?>) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList
NumberedList(int, Stream<?>) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList
NumberedList(Object[]) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList: Creates a list with initial objects but no set name
NumberedList(String) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList: Creates an empty list with a set name.
NumberedList(String, int) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList: Creates an empty list with a set name and set starting digit.
NumberedList(String, int, Object[]) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList: Creates a list with a name, set starting index, and initial objects
NumberedList(String, int, List<?>) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList
NumberedList(String, int, Stream<?>) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList
NumberedList(String, Object[]) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList: Creates a list with a set name and initial objects
NumberedList(String, List<?>) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList
NumberedList(String, Stream<?>) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList
NumberedList(List<?>) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList
NumberedList(Stream<?>) - Constructor for class org.tealeaf.javamarkdown.elements.NumberedList

O

object - Variable in class org.tealeaf.javamarkdown.types.Markup: Object to insert into the markup
org.tealeaf.javamarkdown - package org.tealeaf.javamarkdown
org.tealeaf.javamarkdown.elements - package org.tealeaf.javamarkdown.elements
org.tealeaf.javamarkdown.exceptions - package org.tealeaf.javamarkdown.exceptions
org.tealeaf.javamarkdown.types - package org.tealeaf.javamarkdown.types

P

printItem(int) - Method in class org.tealeaf.javamarkdown.types.ListStructure: Formats and prints an item at the provided index.

R

requiresNewlineAfter() - Method in class org.tealeaf.javamarkdown.MarkdownElement: Whether a new line should be added after inserting the element into a document.
requiresNewlineAfter() - Method in class org.tealeaf.javamarkdown.types.InlineElement: Whether a new line should be added after inserting the element into a document.
requiresNewlineAfter() - Method in class org.tealeaf.javamarkdown.types.ListStructure: Whether a new line should be added after inserting the element into a document.
requiresNewlineAfter() - Method in class org.tealeaf.javamarkdown.types.Structure: Whether a new line should be added after inserting the element into a document.
requiresNewlineBefore() - Method in class org.tealeaf.javamarkdown.MarkdownElement: Whether the element requires at least one \n before printing itself in a document
requiresNewlineBefore() - Method in class org.tealeaf.javamarkdown.types.InlineElement: Whether the element requires at least one \n before printing itself in a document
requiresNewlineBefore() - Method in class org.tealeaf.javamarkdown.types.ListStructure: Whether the element requires at least one \n before printing itself in a document
requiresNewlineBefore() - Method in class org.tealeaf.javamarkdown.types.Structure: Whether the element requires at least one \n before printing itself in a document
RIGHT - Enum constant in enum class org.tealeaf.javamarkdown.elements.Table.Alignment: Aligns all text to the right in the cell

S

setAlignments(Table.Alignment...) - Method in class org.tealeaf.javamarkdown.elements.Table: Sets the alignments for the table
setHeaders(Object...) - Method in class org.tealeaf.javamarkdown.elements.Table: Sets the headers and defaults the alignments to all be CENTER
Strikethrough - Class in org.tealeaf.javamarkdown.elements: Creates an element whose contents are crossed out, ~~such as this~~.
Strikethrough(Object) - Constructor for class org.tealeaf.javamarkdown.elements.Strikethrough: Creates a new StrikeThrough node, which renders its contents as ~~struck out~~.
Structure - Class in org.tealeaf.javamarkdown.types: A base class for any MarkdownElement that formats its contents into a structure-syntax, such as tables or lists.
Structure() - Constructor for class org.tealeaf.javamarkdown.types.Structure
syntax - Variable in class org.tealeaf.javamarkdown.types.Markup: The syntax used in the markup language

T

Table - Class in org.tealeaf.javamarkdown.elements: Renders a Table in Markdown, including Headers and row-by-row contents
Table() - Constructor for class org.tealeaf.javamarkdown.elements.Table: Creates a new Table object
Table.Alignment - Enum Class in org.tealeaf.javamarkdown.elements: Represents the alignment value used for columns in a Table
toAppendable(T) - Method in class org.tealeaf.javamarkdown.MarkdownElement: Outputs the MarkdownElement into an appendable class
toString() - Method in enum class org.tealeaf.javamarkdown.elements.Table.Alignment
toString() - Method in class org.tealeaf.javamarkdown.MarkdownBuffer
toString() - Method in class org.tealeaf.javamarkdown.MarkdownElement: Prints the compiled string representation of the element
toString() - Method in class org.tealeaf.javamarkdown.MarkdownWriter
toWriter(T) - Method in class org.tealeaf.javamarkdown.MarkdownBuffer: Attempts to render and write all objects to a Writer.
toWriter(T) - Method in class org.tealeaf.javamarkdown.MarkdownElement: Writes the formatted item to a Writer

V

valueOf(String) - Static method in enum class org.tealeaf.javamarkdown.elements.Table.Alignment: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.tealeaf.javamarkdown.elements.Table.Alignment: Returns an array containing the constants of this enum class, in the order they are declared.

W

write(char[], int, int) - Method in class org.tealeaf.javamarkdown.MarkdownWriter

A B C F G H I L M N O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form