info.bliki.wiki.model

Interface IConfiguration

All Known Subinterfaces:

IWikiModel

All Known Implementing Classes:

AbstractWikiModel, Configuration, WikiModel

public interface IConfiguration

Configuration interface for extensions similar to the Mediawiki HTML styled tag extension, template parser functions and interwiki links

See Also:

Configuration

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IConfiguration.Casing

Method Summary

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
IConfiguration.Casing	casing()
Map<String,SourceCodeFormatter>	getCodeFormatterMap() Get the source code formatter map of built-in source code formatters
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,...
void	setTemplateCallsCache(Map<String,String> map) Set a cache map implementation.

Method Detail

addCodeFormatter

SourceCodeFormatter addCodeFormatter(String key,
                                     SourceCodeFormatter value)

Add a new source code formatter to the configuration

addInterwikiLink

String addInterwikiLink(String key,
                        String value)

Add another Interwiki link to the configuration. The value string must contain the $1 placeholder for the used wiki article link.

Parameters:

key - the prefix used in the interwiki link (i.e. [[prefix:...]] )

value - the external link which should be generated from the interwiki link

addTemplateFunction

ITemplateFunction addTemplateFunction(String key,
                                      ITemplateFunction value)

Add a new interwiki link to the configuration

addTokenTag

TagToken addTokenTag(String key,
                     TagToken value)

Add a new HTML styled tag to the configuration

getCodeFormatterMap

Map<String,SourceCodeFormatter> getCodeFormatterMap()

Get the source code formatter map of built-in source code formatters

getTemplateCallsCache

Map<String,String> getTemplateCallsCache()

Get the currently configured cache implementation for template calls.

Returns:

null if no cache implementation is set.

See Also:

setTemplateCallsCache(Map)

getTemplateMap

Map<String,ITemplateFunction> getTemplateMap()

Get the template parser functions map of built-in template functions

getTokenMap

Map<String,TagToken> getTokenMap()

Get the HTML styled tag map for built-in tags

getUriSchemeSet

Set<String> getUriSchemeSet()

Get the set of all allowed URI scheme shortcuts like http, https, ftp,... See URI scheme

setTemplateCallsCache

void setTemplateCallsCache(Map<String,String> map)

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.

Parameters:

map - the cache implementation

casing

IConfiguration.Casing casing()

Returns:

the default casing, defaults to IConfiguration.Casing.FirstLetter.