Package com.helger.html.markdown

Class MarkdownConfiguration.Builder

java.lang.Object

com.helger.html.markdown.MarkdownConfiguration.Builder

All Implemented Interfaces:

com.helger.commons.builder.IBuilder<MarkdownConfiguration>

Enclosing class:

MarkdownConfiguration

public static class MarkdownConfiguration.Builder
extends Object
implements com.helger.commons.builder.IBuilder<MarkdownConfiguration>

Configuration builder.

Since:

0.7

Author:

René Jeschke <rene_jeschke@yahoo.de>

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
MarkdownConfiguration	build()	Builds a configuration instance.
MarkdownConfiguration.Builder	codeBlockEmitter(IMarkdownBlockEmitter emitter)	Sets the code block emitter.
MarkdownConfiguration.Builder	convertNewline2Br()	convertNewline2Br.
IMarkdownDecorator	decorator()
MarkdownConfiguration.Builder	decorator(IMarkdownDecorator aDecorator)	Sets the decorator for txtmark.
MarkdownConfiguration.Builder	encoding(Charset aEncoding)	Sets the character encoding for txtmark.
MarkdownConfiguration.Builder	extendedProfile(boolean bExtendedProfile)	Forces extended profile to be enabled by default.
MarkdownConfiguration.Builder	registerPlugins(AbstractMarkdownPlugin... aPlugins)	Sets the plugins.
MarkdownConfiguration.Builder	safeMode(boolean flag)	Sets the HTML safe mode flag.
MarkdownConfiguration.Builder	specialLinkEmitter(IMarkdownSpanEmitter emitter)	Sets the emitter for special link spans ([[ ... ]]).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructor.

Method Detail

extendedProfile

@Nonnull
public MarkdownConfiguration.Builder extendedProfile(boolean bExtendedProfile)

Forces extended profile to be enabled by default.

Parameters:

bExtendedProfile - true to use extended profile

Returns:

This builder.

Since:

0.7

convertNewline2Br

@Nonnull
public MarkdownConfiguration.Builder convertNewline2Br()

convertNewline2Br.

Returns:

This builder.

safeMode

@Nonnull
public MarkdownConfiguration.Builder safeMode(boolean flag)

Sets the HTML safe mode flag. Default: false

Parameters:

flag - true to enable safe mode

Returns:

This builder

Since:

0.7

encoding

@Nonnull
public MarkdownConfiguration.Builder encoding(@Nonnull
                                              Charset aEncoding)

Sets the character encoding for txtmark. Default: "UTF-8"

Parameters:

aEncoding - The encoding

Returns:

This builder

Since:

0.7

decorator

@Nonnull
public IMarkdownDecorator decorator()

decorator

@Nonnull
public MarkdownConfiguration.Builder decorator(@Nonnull
                                               IMarkdownDecorator aDecorator)

Sets the decorator for txtmark. Default: DefaultDecorator()

Parameters:

aDecorator - The decorator

Returns:

This builder

Since:

0.7

See Also:

MarkdownDefaultDecorator

codeBlockEmitter

@Nonnull
public MarkdownConfiguration.Builder codeBlockEmitter(@Nullable
                                                      IMarkdownBlockEmitter emitter)

Sets the code block emitter. Default: null

Parameters:

emitter - The BlockEmitter

Returns:

This builder

Since:

0.7

See Also:

IMarkdownBlockEmitter

specialLinkEmitter

@Nonnull
public MarkdownConfiguration.Builder specialLinkEmitter(@Nullable
                                                        IMarkdownSpanEmitter emitter)

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

Parameters:

emitter - The emitter.

Returns:

This builder.

Since:

0.7

registerPlugins

@Nonnull
public MarkdownConfiguration.Builder registerPlugins(@Nonnull
                                                     AbstractMarkdownPlugin... aPlugins)

Sets the plugins.

Parameters:

aPlugins - The plugins.

Returns:

This builder.

build

@Nonnull
public MarkdownConfiguration build()

Builds a configuration instance.

Specified by:

build in interface com.helger.commons.builder.IBuilder<MarkdownConfiguration>

Returns:

a Configuration instance

Since:

0.7