Configuration (Bliki (Core) 3.1.0 API)

java.lang.Object
- info.bliki.wiki.model.Configuration

All Implemented Interfaces:: IConfiguration

public class Configuration
extends Object
implements IConfiguration

Common Configuration settings

Nested Class Summary
- Nested classes/interfaces inherited from interface info.bliki.wiki.model.IConfiguration
  IConfiguration.Casing

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`AVOID_PAGE_BREAK_IN_TABLE` Tries to avoid page breaks inside tables, e.g. for printouts (disable to get more MediaWiki-compliant HTML code).
`static String`	`BLIKI_VERSION` Get the current `Bliki.info Engine` version
`protected static HashMap<String,SourceCodeFormatter>`	`CODE_FORMATTER_MAP` Map the source code's language string to the code formatter implementation
`static boolean`	`DEBUG` Print additional debug information to System.out
`static String`	`DEFAULT_WIKI_ID`
`static HTMLTag`	`HTML_ABBR_OPEN`
`static HTMLTag`	`HTML_BIG_OPEN`
`static HTMLTag`	`HTML_BLOCKQUOTE_OPEN`
`static HTMLTag`	`HTML_BOLD_OPEN`
`static HTMLTag`	`HTML_CAPTION_OPEN`
`static HTMLTag`	`HTML_CENTER_OPEN`
`static HTMLTag`	`HTML_CITE_OPEN`
`static HTMLTag`	`HTML_CODE_OPEN`
`static HTMLTag`	`HTML_DEL_OPEN`
`static HTMLTag`	`HTML_DIV_OPEN`
`static HTMLTag`	`HTML_EM_OPEN`
`static HTMLTag`	`HTML_FONT_OPEN`
`static HTMLTag`	`HTML_H1_OPEN`
`static HTMLTag`	`HTML_H2_OPEN`
`static HTMLTag`	`HTML_H3_OPEN`
`static HTMLTag`	`HTML_H4_OPEN`
`static HTMLTag`	`HTML_H5_OPEN`
`static HTMLTag`	`HTML_H6_OPEN`
`static HTMLTag`	`HTML_ITALIC_OPEN`
`static HTMLTag`	`HTML_LI_OPEN`
`static HTMLTag`	`HTML_OL_OPEN`
`static HTMLTag`	`HTML_PARAGRAPH_OPEN`
`static HTMLTag`	`HTML_PRE_OPEN`
`static HTMLTag`	`HTML_S_OPEN`
`static HTMLTag`	`HTML_SMALL_OPEN`
`static HTMLTag`	`HTML_SPAN_OPEN`
`static HTMLTag`	`HTML_STRIKE_OPEN`
`static HTMLTag`	`HTML_STRONG_OPEN`
`static HTMLTag`	`HTML_SUB_OPEN`
`static HTMLTag`	`HTML_SUP_OPEN`
`static HTMLTag`	`HTML_TABLE_OPEN`
`static HTMLTag`	`HTML_TD_OPEN`
`static HTMLTag`	`HTML_TH_OPEN`
`static HTMLTag`	`HTML_TR_OPEN`
`static HTMLTag`	`HTML_TT_OPEN`
`static HTMLTag`	`HTML_UL_OPEN`
`static HTMLTag`	`HTML_UNDERLINE_OPEN`
`static HTMLTag`	`HTML_VAR_OPEN`
`static int`	`MAX_CACHE_KEY_LENGTH` Limits the length of the template cache key to this length.
`static Pattern`	`NOWIKI_CLOSE_PATTERN`
`static Pattern`	`NOWIKI_OPEN_PATTERN`
`static boolean`	`PARSER_FUNCTIONS` Print parser function calls (ITemplateFunction calls) with isSubst==false
`static int`	`PARSER_RECURSION_LIMIT` Limits the recursive call of the Wikipedia and Template parser to a depth of PARSER_RECURSION_LIMIT
`static boolean`	`RAW_CONTENT` Print raw content calls
`static int`	`RENDERER_RECURSION_LIMIT` Limits the recursive call of the HTMLConverter renderer to a depth of RENDERER_RECURSION_LIMIT
`static String`	`SPECIAL_BLOCK_TAGS`
`static boolean`	`STACKTRACE` Print additional stack trace information to System.out
`protected static HashMap<String,TagToken>`	`TAG_TOKEN_MAP` Map the HTML token string to the correspoding TagToken implementation
`static int`	`TEMPLATE_BUFFER_LIMIT` Limits the Scanner buffer.
`protected static Map<String,ITemplateFunction>`	`TEMPLATE_FUNCTION_MAP` Map the template's function name to the TemplateFunction implementation
`static boolean`	`TEMPLATE_NAMES` Print template calls
`static int`	`TEMPLATE_RECURSION_LIMIT` Limits the recursive call of the Template parser to a depth of TEMPLATE_RECURSION_LIMIT
`static int`	`TEMPLATE_VALUE_LIMIT` Limits the template parameter value length
`protected static Set<String>`	`URI_SCHEME_MAP` Allowed URI schemes

Constructor Summary

Constructors
Constructor and Description

Configuration()

Configuration(String wikiId, IConfiguration.Casing casing)

Constructors
Constructor and Description
`Configuration()`
`Configuration(String wikiId, IConfiguration.Casing casing)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SourceCodeFormatter`	`addCodeFormatter(String key, SourceCodeFormatter value)` Add a new source code formatter to the configuration
`String`	`addInterwikiLink(String key, String value)` Add another Interwiki link to the configuration.
`ITemplateFunction`	`addTemplateFunction(String key, ITemplateFunction value)` Add a new interwiki link to the configuration
`TagToken`	`addTokenTag(String key, TagToken value)` Add a new HTML styled tag to the configuration
`boolean`	`addUriScheme(String uriKey)` Add an allowed URI scheme shortcut like http, https, ftp,...
`IConfiguration.Casing`	`casing()`
`Map<String,SourceCodeFormatter>`	`getCodeFormatterMap()` Get the source code formatter map of built-in source code formatters
`Map<String,String>`	`getInterWikiMapping()`
`Map<String,String>`	`getTemplateCallsCache()` Get the currently configured cache implementation for template calls.
`Map<String,ITemplateFunction>`	`getTemplateMap()` Get the template parser functions map of built-in template functions
`Map<String,TagToken>`	`getTokenMap()` Get the HTML styled tag map for built-in tags
`Set<String>`	`getUriSchemeSet()` Get the set of all allowed URI scheme shortcuts like http, https, ftp,...
`String`	`getWikiId()`
`void`	`setTemplateCallsCache(Map<String,String> map)` Set a cache map implementation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BLIKI_VERSION
```
public static final String BLIKI_VERSION
```
    Get the current Bliki.info Engine version
    
    See Also:
    
    Constant Field Values
  - DEBUG
```
public static final boolean DEBUG
```
    Print additional debug information to System.out
    
    See Also:
    
    Constant Field Values
  - STACKTRACE
```
public static final boolean STACKTRACE
```
    Print additional stack trace information to System.out
    
    See Also:
    
    Constant Field Values
  - PARSER_FUNCTIONS
```
public static final boolean PARSER_FUNCTIONS
```
    Print parser function calls (ITemplateFunction calls) with isSubst==false
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_NAMES
```
public static final boolean TEMPLATE_NAMES
```
    Print template calls
    
    See Also:
    
    AbstractWikiModel.substituteTemplateCall(String, Map, Appendable), Constant Field Values
  - RAW_CONTENT
```
public static final boolean RAW_CONTENT
```
    Print raw content calls
    
    See Also:
    
    IWikiModel.getRawWikiContent(ParsedPageName, Map), Constant Field Values
  - SPECIAL_BLOCK_TAGS
```
public static final String SPECIAL_BLOCK_TAGS
```
    See Also:
    
    Constant Field Values
  - HTML_ABBR_OPEN
```
public static final HTMLTag HTML_ABBR_OPEN
```
  - HTML_EM_OPEN
```
public static final HTMLTag HTML_EM_OPEN
```
  - HTML_H1_OPEN
```
public static final HTMLTag HTML_H1_OPEN
```
  - HTML_H2_OPEN
```
public static final HTMLTag HTML_H2_OPEN
```
  - HTML_H3_OPEN
```
public static final HTMLTag HTML_H3_OPEN
```
  - HTML_H4_OPEN
```
public static final HTMLTag HTML_H4_OPEN
```
  - HTML_H5_OPEN
```
public static final HTMLTag HTML_H5_OPEN
```
  - HTML_H6_OPEN
```
public static final HTMLTag HTML_H6_OPEN
```
  - HTML_ITALIC_OPEN
```
public static final HTMLTag HTML_ITALIC_OPEN
```
  - HTML_BOLD_OPEN
```
public static final HTMLTag HTML_BOLD_OPEN
```
  - HTML_PARAGRAPH_OPEN
```
public static final HTMLTag HTML_PARAGRAPH_OPEN
```
  - HTML_BLOCKQUOTE_OPEN
```
public static final HTMLTag HTML_BLOCKQUOTE_OPEN
```
  - HTML_STRIKE_OPEN
```
public static final HTMLTag HTML_STRIKE_OPEN
```
  - HTML_STRONG_OPEN
```
public static final HTMLTag HTML_STRONG_OPEN
```
  - HTML_UNDERLINE_OPEN
```
public static final HTMLTag HTML_UNDERLINE_OPEN
```
  - HTML_SUB_OPEN
```
public static final HTMLTag HTML_SUB_OPEN
```
  - HTML_SUP_OPEN
```
public static final HTMLTag HTML_SUP_OPEN
```
  - HTML_CENTER_OPEN
```
public static final HTMLTag HTML_CENTER_OPEN
```
  - HTML_TT_OPEN
```
public static final HTMLTag HTML_TT_OPEN
```
  - HTML_TABLE_OPEN
```
public static final HTMLTag HTML_TABLE_OPEN
```
  - HTML_CAPTION_OPEN
```
public static final HTMLTag HTML_CAPTION_OPEN
```
  - HTML_TH_OPEN
```
public static final HTMLTag HTML_TH_OPEN
```
  - HTML_TR_OPEN
```
public static final HTMLTag HTML_TR_OPEN
```
  - HTML_TD_OPEN
```
public static final HTMLTag HTML_TD_OPEN
```
  - HTML_UL_OPEN
```
public static final HTMLTag HTML_UL_OPEN
```
  - HTML_OL_OPEN
```
public static final HTMLTag HTML_OL_OPEN
```
  - HTML_LI_OPEN
```
public static final HTMLTag HTML_LI_OPEN
```
  - HTML_FONT_OPEN
```
public static final HTMLTag HTML_FONT_OPEN
```
  - HTML_CITE_OPEN
```
public static final HTMLTag HTML_CITE_OPEN
```
  - HTML_DIV_OPEN
```
public static final HTMLTag HTML_DIV_OPEN
```
  - HTML_SPAN_OPEN
```
public static final HTMLTag HTML_SPAN_OPEN
```
  - HTML_VAR_OPEN
```
public static final HTMLTag HTML_VAR_OPEN
```
  - HTML_CODE_OPEN
```
public static final HTMLTag HTML_CODE_OPEN
```
  - HTML_S_OPEN
```
public static final HTMLTag HTML_S_OPEN
```
  - HTML_SMALL_OPEN
```
public static final HTMLTag HTML_SMALL_OPEN
```
  - HTML_BIG_OPEN
```
public static final HTMLTag HTML_BIG_OPEN
```
  - HTML_DEL_OPEN
```
public static final HTMLTag HTML_DEL_OPEN
```
  - HTML_PRE_OPEN
```
public static final HTMLTag HTML_PRE_OPEN
```
  - DEFAULT_WIKI_ID
```
public static final String DEFAULT_WIKI_ID
```
    See Also:
    
    Constant Field Values
  - TAG_TOKEN_MAP
```
protected static final HashMap<String,TagToken> TAG_TOKEN_MAP
```
    Map the HTML token string to the correspoding TagToken implementation
  - CODE_FORMATTER_MAP
```
protected static final HashMap<String,SourceCodeFormatter> CODE_FORMATTER_MAP
```
    Map the source code's language string to the code formatter implementation
  - TEMPLATE_FUNCTION_MAP
```
protected static final Map<String,ITemplateFunction> TEMPLATE_FUNCTION_MAP
```
    Map the template's function name to the TemplateFunction implementation
  - URI_SCHEME_MAP
```
protected static final Set<String> URI_SCHEME_MAP
```
    Allowed URI schemes
  - NOWIKI_OPEN_PATTERN
```
public static final Pattern NOWIKI_OPEN_PATTERN
```
  - NOWIKI_CLOSE_PATTERN
```
public static final Pattern NOWIKI_CLOSE_PATTERN
```
  - MAX_CACHE_KEY_LENGTH
```
public static final int MAX_CACHE_KEY_LENGTH
```
    Limits the length of the template cache key to this length.
    
    See Also:
    
    Constant Field Values
  - PARSER_RECURSION_LIMIT
```
public static final int PARSER_RECURSION_LIMIT
```
    Limits the recursive call of the Wikipedia and Template parser to a depth of PARSER_RECURSION_LIMIT
    
    See Also:
    
    Constant Field Values
  - RENDERER_RECURSION_LIMIT
```
public static final int RENDERER_RECURSION_LIMIT
```
    Limits the recursive call of the HTMLConverter renderer to a depth of RENDERER_RECURSION_LIMIT
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_RECURSION_LIMIT
```
public static final int TEMPLATE_RECURSION_LIMIT
```
    Limits the recursive call of the Template parser to a depth of TEMPLATE_RECURSION_LIMIT
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_BUFFER_LIMIT
```
public static final int TEMPLATE_BUFFER_LIMIT
```
    Limits the Scanner buffer.
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_VALUE_LIMIT
```
public static final int TEMPLATE_VALUE_LIMIT
```
    Limits the template parameter value length
    
    See Also:
    
    Constant Field Values
  - AVOID_PAGE_BREAK_IN_TABLE
```
public static boolean AVOID_PAGE_BREAK_IN_TABLE
```
    Tries to avoid page breaks inside tables, e.g. for printouts (disable to get more MediaWiki-compliant HTML code). Note: Only supported by Opera, according to http://www.w3schools.com/cssref/pr_print_pagebi.asp
- Constructor Detail
  - Configuration
```
public Configuration()
```
  - Configuration
```
public Configuration(String wikiId,
                     IConfiguration.Casing casing)
```
- Method Detail
  - addInterwikiLink
```
public String addInterwikiLink(String key,
                               String value)
```
    Description copied from interface: IConfiguration
    
    Add another Interwiki link to the configuration. The value string must contain the $1 placeholder for the used wiki article link.
    
    Specified by:
    
    addInterwikiLink in interface IConfiguration
    
    Parameters:
    
    key - the prefix used in the interwiki link (i.e. [[prefix:...]] )
    
    value - the external link which should be generated from the interwiki link
  - getWikiId
```
public String getWikiId()
```
    Returns:
    
    the wikiId, e.g. enwiki, frwiktionary etc.
  - getInterWikiMapping
```
public Map<String,String> getInterWikiMapping()
```
  - getUriSchemeSet
```
public Set<String> getUriSchemeSet()
```
    Get the set of all allowed URI scheme shortcuts like http, https, ftp,... See URI scheme
    
    Specified by:
    
    getUriSchemeSet in interface IConfiguration
  - addUriScheme
```
public boolean addUriScheme(String uriKey)
```
    Add an allowed URI scheme shortcut like http, https, ftp,... See URI scheme
    
    Returns:
    
    true if the set did not already contain the specified URI key.
  - getTemplateMap
```
public Map<String,ITemplateFunction> getTemplateMap()
```
    Description copied from interface: IConfiguration
    
    Get the template parser functions map of built-in template functions
    
    Specified by:
    
    getTemplateMap in interface IConfiguration
  - addTemplateFunction
```
public ITemplateFunction addTemplateFunction(String key,
                                             ITemplateFunction value)
```
    Description copied from interface: IConfiguration
    
    Add a new interwiki link to the configuration
    
    Specified by:
    
    addTemplateFunction in interface IConfiguration
  - getTemplateCallsCache
```
public Map<String,String> getTemplateCallsCache()
```
    Description copied from interface: IConfiguration
    
    Get the currently configured cache implementation for template calls.
    
    Specified by:
    
    getTemplateCallsCache in interface IConfiguration
    
    Returns:
    
    null if no cache implementation is set.
    
    See Also:
    
    IConfiguration.setTemplateCallsCache(Map)
  - setTemplateCallsCache
```
public void setTemplateCallsCache(Map<String,String> map)
```
    Description copied from interface: IConfiguration
    
    Set a cache map implementation. For example based on JSR 107. Template calls which use the same parameters over and over again do lookup this cache and use the preparsed result if available. Note: don't use a simple java.util.HashMap implementation because it's not thread-safe an grows infinitly.
    
    Specified by:
    
    setTemplateCallsCache in interface IConfiguration
    
    Parameters:
    
    map - the cache implementation
  - casing
```
public IConfiguration.Casing casing()
```
    Specified by:
    
    casing in interface IConfiguration
    
    Returns:
    
    the default casing, defaults to IConfiguration.Casing.FirstLetter.
  - getCodeFormatterMap
```
public Map<String,SourceCodeFormatter> getCodeFormatterMap()
```
    Description copied from interface: IConfiguration
    
    Get the source code formatter map of built-in source code formatters
    
    Specified by:
    
    getCodeFormatterMap in interface IConfiguration
  - addCodeFormatter
```
public SourceCodeFormatter addCodeFormatter(String key,
                                            SourceCodeFormatter value)
```
    Description copied from interface: IConfiguration
    
    Add a new source code formatter to the configuration
    
    Specified by:
    
    addCodeFormatter in interface IConfiguration
  - getTokenMap
```
public Map<String,TagToken> getTokenMap()
```
    Description copied from interface: IConfiguration
    
    Get the HTML styled tag map for built-in tags
    
    Specified by:
    
    getTokenMap in interface IConfiguration
  - addTokenTag
```
public TagToken addTokenTag(String key,
                            TagToken value)
```
    Description copied from interface: IConfiguration
    
    Add a new HTML styled tag to the configuration
    
    Specified by:
    
    addTokenTag in interface IConfiguration

Class Configuration

Nested Class Summary

Nested classes/interfaces inherited from interface info.bliki.wiki.model.IConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLIKI_VERSION

DEBUG

STACKTRACE

PARSER_FUNCTIONS

TEMPLATE_NAMES

RAW_CONTENT

SPECIAL_BLOCK_TAGS

HTML_ABBR_OPEN

HTML_EM_OPEN

HTML_H1_OPEN

HTML_H2_OPEN

HTML_H3_OPEN

HTML_H4_OPEN

HTML_H5_OPEN

HTML_H6_OPEN

HTML_ITALIC_OPEN

HTML_BOLD_OPEN

HTML_PARAGRAPH_OPEN

HTML_BLOCKQUOTE_OPEN

HTML_STRIKE_OPEN

HTML_STRONG_OPEN

HTML_UNDERLINE_OPEN

HTML_SUB_OPEN

HTML_SUP_OPEN

HTML_CENTER_OPEN

HTML_TT_OPEN

HTML_TABLE_OPEN

HTML_CAPTION_OPEN

HTML_TH_OPEN

HTML_TR_OPEN

HTML_TD_OPEN

HTML_UL_OPEN

HTML_OL_OPEN

HTML_LI_OPEN

HTML_FONT_OPEN

HTML_CITE_OPEN

HTML_DIV_OPEN

HTML_SPAN_OPEN

HTML_VAR_OPEN

HTML_CODE_OPEN

HTML_S_OPEN

HTML_SMALL_OPEN

HTML_BIG_OPEN

HTML_DEL_OPEN

HTML_PRE_OPEN

DEFAULT_WIKI_ID

TAG_TOKEN_MAP

CODE_FORMATTER_MAP

TEMPLATE_FUNCTION_MAP

URI_SCHEME_MAP

NOWIKI_OPEN_PATTERN

NOWIKI_CLOSE_PATTERN

MAX_CACHE_KEY_LENGTH

PARSER_RECURSION_LIMIT

RENDERER_RECURSION_LIMIT

TEMPLATE_RECURSION_LIMIT

TEMPLATE_BUFFER_LIMIT

TEMPLATE_VALUE_LIMIT

AVOID_PAGE_BREAK_IN_TABLE

Constructor Detail

Configuration

Configuration

Method Detail

addInterwikiLink

getWikiId

getInterWikiMapping

getUriSchemeSet

addUriScheme

getTemplateMap

addTemplateFunction

getTemplateCallsCache

setTemplateCallsCache