A B C D E F G H I L M N O P R S T U V X

A

addLinkRef(String, LinkRef) - Method in class com.github.rjeschke.txtmark.CleaningEmitter

addLinkRef(String, LinkRef) - Method in class com.github.rjeschke.txtmark.DefaultEmitter

addLinkRef(String, LinkRef) - Method in interface com.github.rjeschke.txtmark.Emitter

Adds a LinkRef to this set of LinkRefs.

appendLine(Line) - Method in class com.github.rjeschke.txtmark.Block

Appends the given line to this block.

B

Block - Class in com.github.rjeschke.txtmark

This class represents a block of lines.

Block() - Constructor for class com.github.rjeschke.txtmark.Block

Constructor.

BlockEmitter - Interface in com.github.rjeschke.txtmark

Block emitter interface.

blocks - Variable in class com.github.rjeschke.txtmark.Block

Head and tail of child blocks.

blockTail - Variable in class com.github.rjeschke.txtmark.Block

Head and tail of child blocks.

BlockType - Enum in com.github.rjeschke.txtmark

Block type enum.

build() - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Builds a configuration instance.

builder() - Static method in class com.github.rjeschke.txtmark.Configuration

Creates a new Builder instance.

C

CleaningEmitter - Class in com.github.rjeschke.txtmark

CleaningEmitter(Decorator) - Constructor for class com.github.rjeschke.txtmark.CleaningEmitter

CleaningEmitter(Configuration) - Constructor for class com.github.rjeschke.txtmark.CleaningEmitter

CleaningProcessor - Class in com.github.rjeschke.txtmark

Markdown processor class.

closeBlockquote(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a blockquote is closed.

closeBlockquote(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeCodeBlock(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a code block is closed.

closeCodeBlock(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeCodeSpan(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a code span is closed.

closeCodeSpan(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeEmphasis(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an emphasis span is closed.

closeEmphasis(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeHeadline(StringBuilder, int) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a headline is closed.

closeHeadline(StringBuilder, int) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeImage(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an image is closed.

closeImage(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeLink(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a link is closed

closeLink(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeListItem(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a list item is closed.

closeListItem(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeOrderedList(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an ordered list is closed.

closeOrderedList(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeParagraph(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a paragraph is closed.

closeParagraph(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeStrong(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a strong span is closed.

closeStrong(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeSuper(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a superscript span is closed.

closeSuper(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

closeUnorderedList(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an unordered list is closed.

closeUnorderedList(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

com.github.rjeschke.txtmark - package com.github.rjeschke.txtmark

com.github.rjeschke.txtmark.cmd - package com.github.rjeschke.txtmark.cmd

Configuration - Class in com.github.rjeschke.txtmark

Txtmark configuration.

Configuration.Builder - Class in com.github.rjeschke.txtmark

Configuration builder.

D

Decorator - Interface in com.github.rjeschke.txtmark

Decorator interface.

DEFAULT - Static variable in class com.github.rjeschke.txtmark.Configuration

This is the default configuration for txtmark's process methods

DEFAULT_SAFE - Static variable in class com.github.rjeschke.txtmark.Configuration

Default safe configuration

DefaultDecorator - Class in com.github.rjeschke.txtmark

Default Decorator implementation.

DefaultDecorator() - Constructor for class com.github.rjeschke.txtmark.DefaultDecorator

Constructor.

DefaultEmitter - Class in com.github.rjeschke.txtmark

Emitter class responsible for generating HTML output.

DefaultEmitter(Configuration) - Constructor for class com.github.rjeschke.txtmark.DefaultEmitter

Constructor.

E

emit(StringBuilder, Block) - Method in class com.github.rjeschke.txtmark.CleaningEmitter

emit(StringBuilder, Block) - Method in class com.github.rjeschke.txtmark.DefaultEmitter

emit(StringBuilder, Block) - Method in interface com.github.rjeschke.txtmark.Emitter

Transforms the given block recursively into HTML.

emitBlock(StringBuilder, List<String>, String) - Method in interface com.github.rjeschke.txtmark.BlockEmitter

This method is responsible for outputting a markdown block and for any needed pre-processing like escaping HTML special characters.

emitSpan(StringBuilder, String) - Method in interface com.github.rjeschke.txtmark.SpanEmitter

Emits a span element.

Emitter - Interface in com.github.rjeschke.txtmark

Emitter interface responsible for generating output.

enablePanicMode() - Method in class com.github.rjeschke.txtmark.Configuration.Builder

This allows you to enable 'panicMode'.

enableSafeMode() - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Enables HTML safe mode.

expandListParagraphs() - Method in class com.github.rjeschke.txtmark.Block

Changes all Blocks of type NONE to PARAGRAPH if this Block is a List and any of the ListItems contains a paragraph.

F

forceExtentedProfile() - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Forces extened profile to be enabled by default.

G

getLineType(Configuration) - Method in class com.github.rjeschke.txtmark.Line

Gets this line's type.

H

hasLines() - Method in class com.github.rjeschke.txtmark.Block

hlDepth - Variable in class com.github.rjeschke.txtmark.Block

Depth of headline BlockType.

horizontalRuler(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a horizontal ruler is encountered.

horizontalRuler(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

I

id - Variable in class com.github.rjeschke.txtmark.Block

ID for headlines and list items

init() - Method in class com.github.rjeschke.txtmark.Line

Calculates leading and trailing spaces.

initLeading() - Method in class com.github.rjeschke.txtmark.Line

Recalculate leading spaces.

isAbbrev - Variable in class com.github.rjeschke.txtmark.LinkRef

Flag indicating that this is an abbreviation.

isEmpty - Variable in class com.github.rjeschke.txtmark.Line

Is this line empty?

L

leading - Variable in class com.github.rjeschke.txtmark.Line

Leading and trailing spaces.

Line - Class in com.github.rjeschke.txtmark

This class represents a text line.

Line() - Constructor for class com.github.rjeschke.txtmark.Line

Constructor.

lines - Variable in class com.github.rjeschke.txtmark.Block

Head and tail of linked lines.

lineTail - Variable in class com.github.rjeschke.txtmark.Block

Head and tail of linked lines.

link - Variable in class com.github.rjeschke.txtmark.LinkRef

The link.

LinkRef - Class in com.github.rjeschke.txtmark

A markdown link reference.

LinkRef(String, String, boolean) - Constructor for class com.github.rjeschke.txtmark.LinkRef

Constructor.

M

main(String[]) - Static method in class com.github.rjeschke.txtmark.cmd.Run

main(String[]) - Static method in class com.github.rjeschke.txtmark.Run

Static main.

MarkToken - Enum in com.github.rjeschke.txtmark

Markdown token enumeration.

meta - Variable in class com.github.rjeschke.txtmark.Block

Block meta information

N

next - Variable in class com.github.rjeschke.txtmark.Block

Next block.

next - Variable in class com.github.rjeschke.txtmark.Line

Previous and next line.

nextEmpty - Variable in class com.github.rjeschke.txtmark.Line

Is previous/next line empty?

O

openBlockquote(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a blockquote is opened.

openBlockquote(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openCodeBlock(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a code block is opened.

openCodeBlock(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openCodeSpan(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a code span is opened.

openCodeSpan(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openEmphasis(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an emphasis span is opened.

openEmphasis(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openHeadline(StringBuilder, int) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a headline is opened.

openHeadline(StringBuilder, int) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openImage(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an image is opened.

openImage(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openLink(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a link is opened.

openLink(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openListItem(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a list item is opened.

openListItem(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openOrderedList(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an ordered list is opened.

openOrderedList(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openParagraph(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a paragraph is opened.

openParagraph(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openStrong(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a strong span is opened.

openStrong(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openSuper(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when a superscript span is opened.

openSuper(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

openUnorderedList(StringBuilder) - Method in interface com.github.rjeschke.txtmark.Decorator

Called when an unordered list is opened.

openUnorderedList(StringBuilder) - Method in class com.github.rjeschke.txtmark.DefaultDecorator

P

pos - Variable in class com.github.rjeschke.txtmark.Line

Current cursor position.

prevEmpty - Variable in class com.github.rjeschke.txtmark.Line

Is previous/next line empty?

previous - Variable in class com.github.rjeschke.txtmark.Line

Previous and next line.

process(Reader, Configuration) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML using the given Configuration.

process(String, Configuration) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input String into HTML using the given Configuration.

process(File, Configuration) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML using the given Configuration.

process(InputStream, Configuration) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML using the given Configuration.

process(String) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input String into HTML using the default Configuration.

process(String, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input String into HTML.

process(String, Decorator) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input String into HTML.

process(String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input String into HTML.

process(File) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML using the default Configuration.

process(File, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML.

process(File, Decorator) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML.

process(File, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML.

process(File, String) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML.

process(File, String, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML.

process(File, String, Decorator) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML.

process(File, String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input file into HTML.

process(InputStream) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(InputStream, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(InputStream, Decorator) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(InputStream, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(InputStream, String) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(InputStream, String, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(InputStream, String, Decorator) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(InputStream, String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(Reader) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML using the default Configuration.

process(Reader, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(Reader, Decorator) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(Reader, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.CleaningProcessor

Transforms an input stream into HTML.

process(Reader, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML using the given Configuration.

process(Reader, Emitter, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML using the given Configuration and a custom emitter.

process(String, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML using the given Configuration.

process(File, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML using the given Configuration.

process(InputStream, Configuration) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML using the given Configuration.

process(String) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML using the default Configuration.

process(String, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML.

process(String, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML.

process(String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input String into HTML.

process(File) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML using the default Configuration.

process(File, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, String) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, String, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, String, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(File, String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input file into HTML.

process(InputStream) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, String) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, String, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, String, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(InputStream, String, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(Reader) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML using the default Configuration.

process(Reader, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(Reader, Decorator) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

process(Reader, Decorator, boolean) - Static method in class com.github.rjeschke.txtmark.Processor

Transforms an input stream into HTML.

Processor - Class in com.github.rjeschke.txtmark

Markdown processor class.

R

readUntil(char...) - Method in class com.github.rjeschke.txtmark.Line

Reads chars from this line until any 'end' char is reached.

removeBlockQuotePrefix() - Method in class com.github.rjeschke.txtmark.Block

Used for nested block quotes.

removeLeadingEmptyLines() - Method in class com.github.rjeschke.txtmark.Block

Removes leading empty lines.

removeLine(Line) - Method in class com.github.rjeschke.txtmark.Block

Removes the given line from this block.

removeListIndent(Configuration) - Method in class com.github.rjeschke.txtmark.Block

Used for nested lists.

removeSurroundingEmptyLines() - Method in class com.github.rjeschke.txtmark.Block

Removes leading and trailing empty lines.

removeTrailingEmptyLines() - Method in class com.github.rjeschke.txtmark.Block

Removes trailing empty lines.

Run - Class in com.github.rjeschke.txtmark.cmd

Run() - Constructor for class com.github.rjeschke.txtmark.cmd.Run

Run - Class in com.github.rjeschke.txtmark

Simple class for processing markdown files on the command line.

Run() - Constructor for class com.github.rjeschke.txtmark.Run

S

setAllowSpacesInFencedCodeBlockDelimiters(boolean) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

(Dis-)Allows spaces in fenced code block delimiter lines.

setCodeBlockEmitter(BlockEmitter) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the code block emitter.

setDecorator(Decorator) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the decorator for txtmark.

setEmpty() - Method in class com.github.rjeschke.txtmark.Line

Marks this line empty.

setEnablePanicMode(boolean) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

This allows you to enable 'panicMode'.

setEncoding(String) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the character encoding for txtmark.

setSafeMode(boolean) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the HTML safe mode flag.

setSpecialLinkEmitter(SpanEmitter) - Method in class com.github.rjeschke.txtmark.Configuration.Builder

Sets the emitter for special link spans ([[ ...

setUseExtensions(boolean) - Method in class com.github.rjeschke.txtmark.CleaningEmitter

setUseExtensions(boolean) - Method in class com.github.rjeschke.txtmark.DefaultEmitter

setUseExtensions(boolean) - Method in interface com.github.rjeschke.txtmark.Emitter

Sets whether to use the extended profile.

skipSpaces() - Method in class com.github.rjeschke.txtmark.Line

Skips spaces.

SpanEmitter - Interface in com.github.rjeschke.txtmark

An interface for emitting span elements.

split(Line) - Method in class com.github.rjeschke.txtmark.Block

Splits this block's lines, creating a new child block having 'line' as it's lineTail.

stripID() - Method in class com.github.rjeschke.txtmark.Line

Checks if this line contains an ID at it's end and removes it from the line.

T

title - Variable in class com.github.rjeschke.txtmark.LinkRef

The optional comment/title.

toString() - Method in class com.github.rjeschke.txtmark.LinkRef

trailing - Variable in class com.github.rjeschke.txtmark.Line

Leading and trailing spaces.

transfromHeadline() - Method in class com.github.rjeschke.txtmark.Block

Sets hlDepth and takes care of '#' chars.

type - Variable in class com.github.rjeschke.txtmark.Block

This block's type.

U

useExtensions - Variable in class com.github.rjeschke.txtmark.DefaultEmitter

Extension flag.

V

value - Variable in class com.github.rjeschke.txtmark.Line

This line's value.

valueOf(String) - Static method in enum com.github.rjeschke.txtmark.BlockType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.rjeschke.txtmark.MarkToken

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.rjeschke.txtmark.BlockType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.rjeschke.txtmark.MarkToken

Returns an array containing the constants of this enum type, in the order they are declared.

X

xmlEndLine - Variable in class com.github.rjeschke.txtmark.Line

Final line of a XML block.

A B C D E F G H I L M N O P R S T U V X