WikiConfigImpl (SWC - Sweble Engine 3.1.9 API)

java.lang.Object
- org.sweble.wikitext.engine.config.WikiConfigImpl

All Implemented Interfaces:: WikiConfig

public class WikiConfigImpl
extends Object
implements WikiConfig

Constructor Summary

Constructors
Constructor and Description

WikiConfigImpl()

Constructors
Constructor and Description
`WikiConfigImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addI18nAlias(I18nAliasImpl alias)` Aliases apply to the following things: Page switches, e.g.
`void`	`addInterwiki(InterwikiImpl iw)`
`void`	`addNamespace(NamespaceImpl ns)`
`protected void`	`addParserFunction(ParserFunctionBase pfn)`
`void`	`addParserFunctionGroup(ParserFunctionGroup pfnGroup)`
`protected void`	`addTagExtension(TagExtensionBase tagExt)`
`void`	`addTagExtensionGroup(TagExtensionGroup tagExtGroup)`
`boolean`	`equals(Object obj)`
`String`	`getArticlePath()` The equivalent of MediaWiki's $wgArticlePath.
`JAXBSource`	`getAsJAXBSource()`
`EngineAstTextUtils`	`getAstTextUtils()` Should return the same instance as getParserConfig().getAstTextUtils().
`String`	`getContentLanguage()`
`NamespaceImpl`	`getDefaultNamespace()`
`EngineConfigImpl`	`getEngineConfig()`
`Namespace`	`getFileNamespace()`
`I18nAliasImpl`	`getI18nAlias(String name)`
`I18nAliasImpl`	`getI18nAliasById(String id)`
`Collection<I18nAlias>`	`getI18nAliases()`
`InterwikiImpl`	`getInterwiki(String prefix)`
`String`	`getInterwikiPrefix()` Returns the interwiki prefix for the configured wiki instance or null if this wiki itself does not have an interwiki prefix.
`Collection<Interwiki>`	`getInterwikis()`
`NamespaceImpl`	`getNamespace(int id)`
`NamespaceImpl`	`getNamespace(String name)`
`Collection<Namespace>`	`getNamespaces()`
`EngineNodeFactoryImpl`	`getNodeFactory()` Should return the same instance as getParserConfig().getNodeFactory().
`ParserFunctionBase`	`getPageSwitch(String name)` Page switches are a special form of parser function.
`ParserConfigImpl`	`getParserConfig()`
`ParserFunctionBase`	`getParserFunction(String name)` Cannot retrieve page switches.
`Collection<ParserFunctionBase>`	`getParserFunctions()` Returns parser functions and page switches.
`WikiRuntimeInfo`	`getRuntimeInfo()`
`String`	`getSiteName()` Name of this wiki.
`Namespace`	`getSubjectNamespaceFor(Namespace namespace)`
`TagExtensionBase`	`getTagExtension(String name)`
`Collection<TagExtensionBase>`	`getTagExtensions()`
`Namespace`	`getTalkNamespaceFor(Namespace namespace)`
`NamespaceImpl`	`getTemplateNamespace()`
`TimeZone`	`getTimezone()`
`String`	`getWikiUrl()` The equivalent of MediaWiki's $wgScript.
`int`	`hashCode()`
`boolean`	`isTagExtensionNamesCaseSensitive()`
`static WikiConfigImpl`	`load(File file)`
`static WikiConfigImpl`	`load(InputStream in)`
`static WikiConfigImpl`	`load(Reader reader)`
`static WikiConfigImpl`	`load(Source in)`
`void`	`save(File file)`
`void`	`save(OutputStream out)`
`void`	`save(Writer writer)`
`void`	`setContentLang(String contentLang)`
`void`	`setDefaultNamespace(NamespaceImpl defaultNamespace)`
`void`	`setIwPrefix(String iwPrefix)`
`void`	`setRuntimeInfo(WikiRuntimeInfo runtimeInfo)`
`void`	`setSiteName(String siteName)`
`void`	`setTagExtensionNamesCaseSensitive(boolean tagExtensionNamesCaseSensitive)`
`void`	`setTemplateNamespace(NamespaceImpl templateNamespace)`
`void`	`setWikiUrl(String wikiUrl)`

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

- Constructor Detail
  - WikiConfigImpl
```
public WikiConfigImpl()
```
- Method Detail
  - getParserConfig
```
public ParserConfigImpl getParserConfig()
```
    Specified by:
    
    getParserConfig in interface WikiConfig
  - getEngineConfig
```
public EngineConfigImpl getEngineConfig()
```
    Specified by:
    
    getEngineConfig in interface WikiConfig
  - getNodeFactory
```
public EngineNodeFactoryImpl getNodeFactory()
```
    Description copied from interface: WikiConfig
    
    Should return the same instance as getParserConfig().getNodeFactory().
    
    Specified by:
    
    getNodeFactory in interface WikiConfig
  - getAstTextUtils
```
public EngineAstTextUtils getAstTextUtils()
```
    Description copied from interface: WikiConfig
    
    Should return the same instance as getParserConfig().getAstTextUtils().
    
    Specified by:
    
    getAstTextUtils in interface WikiConfig
  - isTagExtensionNamesCaseSensitive
```
public boolean isTagExtensionNamesCaseSensitive()
```
  - setTagExtensionNamesCaseSensitive
```
public void setTagExtensionNamesCaseSensitive(boolean tagExtensionNamesCaseSensitive)
```
  - addNamespace
```
public void addNamespace(NamespaceImpl ns)
```
  - setDefaultNamespace
```
public void setDefaultNamespace(NamespaceImpl defaultNamespace)
```
  - setTemplateNamespace
```
public void setTemplateNamespace(NamespaceImpl templateNamespace)
```
  - getNamespace
```
public NamespaceImpl getNamespace(String name)
```
    Specified by:
    
    getNamespace in interface WikiConfig
  - getNamespaces
```
public Collection<Namespace> getNamespaces()
```
    Specified by:
    
    getNamespaces in interface WikiConfig
  - getNamespace
```
public NamespaceImpl getNamespace(int id)
```
    Specified by:
    
    getNamespace in interface WikiConfig
  - getDefaultNamespace
```
public NamespaceImpl getDefaultNamespace()
```
    Specified by:
    
    getDefaultNamespace in interface WikiConfig
  - getTemplateNamespace
```
public NamespaceImpl getTemplateNamespace()
```
    Specified by:
    
    getTemplateNamespace in interface WikiConfig
  - getFileNamespace
```
public Namespace getFileNamespace()
```
    Specified by:
    
    getFileNamespace in interface WikiConfig
  - getSubjectNamespaceFor
```
public Namespace getSubjectNamespaceFor(Namespace namespace)
```
    Specified by:
    
    getSubjectNamespaceFor in interface WikiConfig
  - getTalkNamespaceFor
```
public Namespace getTalkNamespaceFor(Namespace namespace)
```
    Specified by:
    
    getTalkNamespaceFor in interface WikiConfig
  - addInterwiki
```
public void addInterwiki(InterwikiImpl iw)
```
  - getInterwiki
```
public InterwikiImpl getInterwiki(String prefix)
```
    Specified by:
    
    getInterwiki in interface WikiConfig
  - getInterwikis
```
public Collection<Interwiki> getInterwikis()
```
    Specified by:
    
    getInterwikis in interface WikiConfig
  - addI18nAlias
```
public void addI18nAlias(I18nAliasImpl alias)
```
    Aliases apply to the following things:
    - Page switches, e.g. __NOTOC__. They can be queried using getPageSwitch(). The full name (e.g. " __NOTOC__") has to be specified as alias when specifying an alias as well as when querying the page switch in the expansion process.
    - Parser functions, e.g. lc:. They can be queried using getParserFunction(). The full name plus the colon (e.g. " lc:") has to be specified as alias when specifying an alias as well as when querying the parser function in the expansion process. A parser function that can also be called without arguments is treated as magic word instead (e.g. NAMESPACE instead of NAMESPACE:)!
    - Magic words, e.g. CURRENTDAY. They can be queried using getParserFunction(). The full name (e.g. " CURRENTDAY") has to be specified as alias when specifying an alias as well as when querying the magic word in the expansion process.
    - Redirect keyword
  - getI18nAlias
```
public I18nAliasImpl getI18nAlias(String name)
```
    Specified by:
    
    getI18nAlias in interface WikiConfig
  - getI18nAliasById
```
public I18nAliasImpl getI18nAliasById(String id)
```
  - getI18nAliases
```
public Collection<I18nAlias> getI18nAliases()
```
    Specified by:
    
    getI18nAliases in interface WikiConfig
  - addParserFunctionGroup
```
public void addParserFunctionGroup(ParserFunctionGroup pfnGroup)
```
  - addParserFunction
```
protected void addParserFunction(ParserFunctionBase pfn)
```
  - getParserFunctions
```
public Collection<ParserFunctionBase> getParserFunctions()
```
    Description copied from interface: WikiConfig
    
    Returns parser functions and page switches.
    
    Specified by:
    
    getParserFunctions in interface WikiConfig
  - getParserFunction
```
public ParserFunctionBase getParserFunction(String name)
```
    Description copied from interface: WikiConfig
    
    Cannot retrieve page switches.
    
    Specified by:
    
    getParserFunction in interface WikiConfig
  - getPageSwitch
```
public ParserFunctionBase getPageSwitch(String name)
```
    Description copied from interface: WikiConfig
    
    Page switches are a special form of parser function. They are therefore listed in getParserFunctions(). However, retrieval works only over getPageSwitch().
    
    Specified by:
    
    getPageSwitch in interface WikiConfig
  - addTagExtensionGroup
```
public void addTagExtensionGroup(TagExtensionGroup tagExtGroup)
```
  - addTagExtension
```
protected void addTagExtension(TagExtensionBase tagExt)
```
  - getTagExtensions
```
public Collection<TagExtensionBase> getTagExtensions()
```
    Specified by:
    
    getTagExtensions in interface WikiConfig
  - getTagExtension
```
public TagExtensionBase getTagExtension(String name)
```
    Specified by:
    
    getTagExtension in interface WikiConfig
  - setSiteName
```
public void setSiteName(String siteName)
```
  - getSiteName
```
public String getSiteName()
```
    Description copied from interface: WikiConfig
    
    Name of this wiki.
    
    Specified by:
    
    getSiteName in interface WikiConfig
  - setWikiUrl
```
public void setWikiUrl(String wikiUrl)
```
  - getWikiUrl
```
public String getWikiUrl()
```
    Description copied from interface: WikiConfig
    
    The equivalent of MediaWiki's $wgScript.
    
    Specified by:
    
    getWikiUrl in interface WikiConfig
  - getArticlePath
```
public String getArticlePath()
```
    Description copied from interface: WikiConfig
    
    The equivalent of MediaWiki's $wgArticlePath.
    
    Specified by:
    
    getArticlePath in interface WikiConfig
  - setContentLang
```
public void setContentLang(String contentLang)
```
  - getContentLanguage
```
public String getContentLanguage()
```
    Specified by:
    
    getContentLanguage in interface WikiConfig
  - setIwPrefix
```
public void setIwPrefix(String iwPrefix)
```
  - getInterwikiPrefix
```
public String getInterwikiPrefix()
```
    Description copied from interface: WikiConfig
    
    Returns the interwiki prefix for the configured wiki instance or null if this wiki itself does not have an interwiki prefix.
    
    Specified by:
    
    getInterwikiPrefix in interface WikiConfig
  - getTimezone
```
public TimeZone getTimezone()
```
    Specified by:
    
    getTimezone in interface WikiConfig
  - getRuntimeInfo
```
public WikiRuntimeInfo getRuntimeInfo()
```
    Specified by:
    
    getRuntimeInfo in interface WikiConfig
  - setRuntimeInfo
```
public void setRuntimeInfo(WikiRuntimeInfo runtimeInfo)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - save
```
public void save(File file)
          throws JAXBException
```
    Throws:
    
    JAXBException
  - save
```
public void save(Writer writer)
          throws JAXBException
```
    Throws:
    
    JAXBException
  - save
```
public void save(OutputStream out)
          throws JAXBException
```
    Throws:
    
    JAXBException
  - getAsJAXBSource
```
public JAXBSource getAsJAXBSource()
                           throws JAXBException
```
    Throws:
    
    JAXBException
  - load
```
public static WikiConfigImpl load(File file)
                           throws JAXBException
```
    Throws:
    
    JAXBException
  - load
```
public static WikiConfigImpl load(Reader reader)
                           throws JAXBException
```
    Throws:
    
    JAXBException
  - load
```
public static WikiConfigImpl load(InputStream in)
                           throws JAXBException
```
    Throws:
    
    JAXBException
  - load
```
public static WikiConfigImpl load(Source in)
                           throws JAXBException
```
    Throws:
    
    JAXBException

Class WikiConfigImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WikiConfigImpl

Method Detail

getParserConfig

getEngineConfig

getNodeFactory

getAstTextUtils

isTagExtensionNamesCaseSensitive

setTagExtensionNamesCaseSensitive

addNamespace

setDefaultNamespace

setTemplateNamespace

getNamespace

getNamespaces

getNamespace

getDefaultNamespace

getTemplateNamespace

getFileNamespace

getSubjectNamespaceFor

getTalkNamespaceFor

addInterwiki

getInterwiki

getInterwikis

addI18nAlias

getI18nAlias

getI18nAliasById

getI18nAliases

addParserFunctionGroup

addParserFunction

getParserFunctions

getParserFunction

getPageSwitch

addTagExtensionGroup

addTagExtension

getTagExtensions

getTagExtension

setSiteName

getSiteName

setWikiUrl

getWikiUrl

getArticlePath

setContentLang

getContentLanguage

setIwPrefix

getInterwikiPrefix

getTimezone

getRuntimeInfo

setRuntimeInfo

hashCode

equals

save

save

save

getAsJAXBSource

load

load

load

load