Package org.fugerit.java.doc.freemarker.config

Class FreeMarkerConfigStep

java.lang.Object

org.fugerit.java.core.util.filterchain.MiniFilterBase

org.fugerit.java.doc.base.process.DocProcessorBasic

org.fugerit.java.doc.freemarker.config.FreeMarkerConfigStep

All Implemented Interfaces:

Serializable, org.fugerit.java.core.util.filterchain.MiniFilter, DocProcessor

public class FreeMarkerConfigStep
extends DocProcessorBasic

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATT_DEFAULT
static String	ATT_FREEMARKER_CONFIG_KEY_CLASS
static String	ATT_FREEMARKER_CONFIG_KEY_ENCODING
static String	ATT_FREEMARKER_CONFIG_KEY_ENCODING_DEFAULT
static String	ATT_FREEMARKER_CONFIG_KEY_ENCODING_UTF8
static String	ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER
static String	ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_DEBUG
static String	ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_DEFAULT
static String	ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_HTML_DEBUG
static String	ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_IGNORE
static String	ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_RETHROW
static String	ATT_FREEMARKER_CONFIG_KEY_FALLBACK_ON_NULL_LOOP_VARIABLE
static String	ATT_FREEMARKER_CONFIG_KEY_FALLBACK_ON_NULL_LOOP_VARIABLE_DEFAULT
static String	ATT_FREEMARKER_CONFIG_KEY_LOG_EXCEPTION
static String	ATT_FREEMARKER_CONFIG_KEY_LOG_EXCEPTION_DEFAULT
static String	ATT_FREEMARKER_CONFIG_KEY_MODE
static String	ATT_FREEMARKER_CONFIG_KEY_MODE_CLASS
static String	ATT_FREEMARKER_CONFIG_KEY_MODE_FOLDER
static String	ATT_FREEMARKER_CONFIG_KEY_PATH
static String	ATT_FREEMARKER_CONFIG_KEY_VERSION
static String	ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_29
static String	ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_30
static String	ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_31
static String	ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_32
static String	ATT_FREEMARKER_CONFIG_KEY_VERSION_DEFAULT
static String	ATT_FREEMARKER_CONFIG_KEY_WRAP_UNCHECKED_EXCEPTION
static String	ATT_FREEMARKER_CONFIG_KEY_WRAP_UNCHECKED_EXCEPTION_DEFAULT

Fields inherited from class org.fugerit.java.core.util.filterchain.MiniFilterBase

logger

Fields inherited from interface org.fugerit.java.core.util.filterchain.MiniFilter

ALWAYS, CONTINUE, SKIP

Constructor Summary

Constructors

Constructor	Description
FreeMarkerConfigStep()

Method Summary

Modifier and Type	Method	Description
protected static freemarker.template.Configuration	getConfig(String key, Properties config)
int	process(DocProcessContext context, DocProcessData data)

Methods inherited from class org.fugerit.java.doc.base.process.DocProcessorBasic

apply

Methods inherited from class org.fugerit.java.core.util.filterchain.MiniFilterBase

config, genKey, getChainId, getCustomConfig, getDefaultBehaviour, getDescription, getKey, getParam01, setChainId, setCustomConfig, setParam01, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fugerit.java.core.util.filterchain.MiniFilter

config, getCustomConfig, getDefaultBehaviour, getDescription, getKey, setCustomConfig

Field Detail

ATT_DEFAULT

public static final String ATT_DEFAULT

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_VERSION

public static final String ATT_FREEMARKER_CONFIG_KEY_VERSION

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_32

public static final String ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_32

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_31

public static final String ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_31

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_30

public static final String ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_30

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_29

public static final String ATT_FREEMARKER_CONFIG_KEY_VERSION_2_3_29

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_VERSION_DEFAULT

public static final String ATT_FREEMARKER_CONFIG_KEY_VERSION_DEFAULT

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_MODE

public static final String ATT_FREEMARKER_CONFIG_KEY_MODE

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_MODE_CLASS

public static final String ATT_FREEMARKER_CONFIG_KEY_MODE_CLASS

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_MODE_FOLDER

public static final String ATT_FREEMARKER_CONFIG_KEY_MODE_FOLDER

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_PATH

public static final String ATT_FREEMARKER_CONFIG_KEY_PATH

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_CLASS

public static final String ATT_FREEMARKER_CONFIG_KEY_CLASS

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_ENCODING

public static final String ATT_FREEMARKER_CONFIG_KEY_ENCODING

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_ENCODING_UTF8

public static final String ATT_FREEMARKER_CONFIG_KEY_ENCODING_UTF8

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_ENCODING_DEFAULT

public static final String ATT_FREEMARKER_CONFIG_KEY_ENCODING_DEFAULT

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER

public static final String ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_RETHROW

public static final String ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_RETHROW

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_IGNORE

public static final String ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_IGNORE

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_DEBUG

public static final String ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_DEBUG

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_HTML_DEBUG

public static final String ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_HTML_DEBUG

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_DEFAULT

public static final String ATT_FREEMARKER_CONFIG_KEY_EXCEPTION_HANDLER_DEFAULT

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_LOG_EXCEPTION

public static final String ATT_FREEMARKER_CONFIG_KEY_LOG_EXCEPTION

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_LOG_EXCEPTION_DEFAULT

public static final String ATT_FREEMARKER_CONFIG_KEY_LOG_EXCEPTION_DEFAULT

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_WRAP_UNCHECKED_EXCEPTION

public static final String ATT_FREEMARKER_CONFIG_KEY_WRAP_UNCHECKED_EXCEPTION

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_WRAP_UNCHECKED_EXCEPTION_DEFAULT

public static final String ATT_FREEMARKER_CONFIG_KEY_WRAP_UNCHECKED_EXCEPTION_DEFAULT

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_FALLBACK_ON_NULL_LOOP_VARIABLE

public static final String ATT_FREEMARKER_CONFIG_KEY_FALLBACK_ON_NULL_LOOP_VARIABLE

See Also:

Constant Field Values

ATT_FREEMARKER_CONFIG_KEY_FALLBACK_ON_NULL_LOOP_VARIABLE_DEFAULT

public static final String ATT_FREEMARKER_CONFIG_KEY_FALLBACK_ON_NULL_LOOP_VARIABLE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

FreeMarkerConfigStep

public FreeMarkerConfigStep()

Method Detail

getConfig

protected static freemarker.template.Configuration getConfig(String key,
                                                             Properties config)
                                                      throws Exception

Throws:

Exception

process

public int process(DocProcessContext context,
                   DocProcessData data)
            throws Exception

Specified by:

process in interface DocProcessor

Overrides:

process in class DocProcessorBasic

Throws:

Exception