Package com.helger.html.markdown

Class MarkdownConfiguration

java.lang.Object

com.helger.html.markdown.MarkdownConfiguration

public class MarkdownConfiguration
extends Object

Txtmark configuration.

Author:

René Jeschke <rene_jeschke@yahoo.de>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarkdownConfiguration.Builder	Configuration builder.

Field Summary

Fields

Modifier and Type	Field	Description
static MarkdownConfiguration	DEFAULT	This is the default configuration for txtmark's process methods
static MarkdownConfiguration	DEFAULT_EXTENSIONS	This is the default configuration for txtmark's process methods
static MarkdownConfiguration	DEFAULT_SAFE	Default safe configuration
static MarkdownConfiguration	DEFAULT_SAFE_EXTENSIONS	Default safe configuration

Constructor Summary

Constructors

Constructor	Description
MarkdownConfiguration(boolean bSafeMode, Charset aEncoding, IMarkdownDecorator aDecorator, IMarkdownBlockEmitter aCodeBlockEmitter, boolean bForceExtendedProfile, boolean bConvertNewline2Br, IMarkdownSpanEmitter aSpecialLinkEmitter, List<? extends AbstractMarkdownPlugin> aPlugins)	Constructor.

Method Summary

Modifier and Type	Method	Description
static MarkdownConfiguration.Builder	builder()	Creates a new Builder instance.
com.helger.commons.collection.impl.ICommonsList<AbstractMarkdownPlugin>	getAllPlugins()
IMarkdownBlockEmitter	getCodeBlockEmitter()
IMarkdownDecorator	getDecorator()
Charset	getEncoding()
IMarkdownSpanEmitter	getSpecialLinkEmitter()
boolean	isConvertNewline2Br()
boolean	isExtendedProfile()
boolean	isSafeMode()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final MarkdownConfiguration DEFAULT

This is the default configuration for txtmark's process methods

• safeMode = false
• encoding = UTF-8
• decorator = DefaultDecorator
• codeBlockEmitter = null

DEFAULT_EXTENSIONS

public static final MarkdownConfiguration DEFAULT_EXTENSIONS

This is the default configuration for txtmark's process methods

• safeMode = false
• encoding = UTF-8
• decorator = DefaultDecorator
• codeBlockEmitter = null

DEFAULT_SAFE

public static final MarkdownConfiguration DEFAULT_SAFE

Default safe configuration

• safeMode = true
• encoding = UTF-8
• decorator = DefaultDecorator
• codeBlockEmitter = null

DEFAULT_SAFE_EXTENSIONS

public static final MarkdownConfiguration DEFAULT_SAFE_EXTENSIONS

Default safe configuration

• safeMode = true
• encoding = UTF-8
• decorator = DefaultDecorator
• codeBlockEmitter = null

Constructor Detail

MarkdownConfiguration

public MarkdownConfiguration(boolean bSafeMode,
                             @Nonnull
                             Charset aEncoding,
                             @Nonnull
                             IMarkdownDecorator aDecorator,
                             @Nullable
                             IMarkdownBlockEmitter aCodeBlockEmitter,
                             boolean bForceExtendedProfile,
                             boolean bConvertNewline2Br,
                             @Nullable
                             IMarkdownSpanEmitter aSpecialLinkEmitter,
                             @Nullable
                             List<? extends AbstractMarkdownPlugin> aPlugins)

Constructor.

Parameters:

bSafeMode - safe mode?

aEncoding - Encoding to use

aDecorator - Decorator to use

aCodeBlockEmitter - Code block emitter to use

bForceExtendedProfile - Force extended profile?

bConvertNewline2Br - Convert newline to <br>

aSpecialLinkEmitter - Special link emitted

aPlugins - Custom plugins

Method Detail

isSafeMode

public boolean isSafeMode()

getEncoding

@Nonnull
public Charset getEncoding()

getDecorator

@Nonnull
public IMarkdownDecorator getDecorator()

getCodeBlockEmitter

@Nullable
public IMarkdownBlockEmitter getCodeBlockEmitter()

isExtendedProfile

public boolean isExtendedProfile()

isConvertNewline2Br

public boolean isConvertNewline2Br()

getSpecialLinkEmitter

@Nullable
public IMarkdownSpanEmitter getSpecialLinkEmitter()

getAllPlugins

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<AbstractMarkdownPlugin> getAllPlugins()

builder

@Nonnull
public static MarkdownConfiguration.Builder builder()

Creates a new Builder instance.

Returns:

A new Builder instance.