Namespace (Bliki (Core) 3.1.1-SNAPSHOT-20170407 API)

java.lang.Object
- info.bliki.wiki.namespaces.Namespace

All Implemented Interfaces:

INamespace
```
public class Namespace
extends Object
implements INamespace
```
Mediawiki Namespaces.

See Also:

Mediawiki - Manual:Namespace

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class Namespace.ExtractType

class Namespace.NamespaceValue
Base class for all namespace constants.
- Nested classes/interfaces inherited from interface info.bliki.wiki.namespaces.INamespace
  INamespace.INamespaceValue, INamespace.NamespaceCode

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Namespace.ExtractType`
`class`	`Namespace.NamespaceValue` Base class for all namespace constants.

Field Summary

Fields
Modifier and Type	Field and Description
`Namespace.NamespaceValue`	`BOOK`
`Namespace.NamespaceValue`	`BOOK_TALK`
`Namespace.NamespaceValue`	`CATEGORY` The "Category" namespace for the current language.
`Namespace.NamespaceValue`	`CATEGORY_TALK` The "Category talk" namespace for the current language.
`Namespace.NamespaceValue`	`DRAFT`
`Namespace.NamespaceValue`	`DRAFT_TALK`
`Namespace.NamespaceValue`	`EP`
`Namespace.NamespaceValue`	`EP_TALK`
`protected ResourceBundle`	`fResourceBundle`
`protected ResourceBundle`	`fResourceBundleEn`
`Namespace.NamespaceValue`	`HELP` The "Help" namespace for the current language.
`Namespace.NamespaceValue`	`HELP_TALK` The "Help talk" namespace for the current language.
`Namespace.NamespaceValue`	`IMAGE`
`Namespace.NamespaceValue`	`IMAGE_TALK` NS_IMAGE and NS_IMAGE_TALK are the pre-v1.14 names for NS_FILE and NS_FILE_TALK respectively, and are kept for compatibility.
`Namespace.NamespaceValue`	`MAIN` The main namespace for the current language.
`Namespace.NamespaceValue`	`MEDIA` The "Media" namespace for the current language.
`Namespace.NamespaceValue`	`MEDIAWIKI` The "MediaWiki" namespace for the current language.
`Namespace.NamespaceValue`	`MEDIAWIKI_TALK` The "MediaWiki talk" namespace for the current language.
`Namespace.NamespaceValue`	`MODULE` The "Module" namespace for the current language.
`Namespace.NamespaceValue`	`MODULE_TALK` The "Module talk" namespace for the current language.
`Namespace.NamespaceValue`	`PORTAL` The "Portal" namespace for the current language.
`Namespace.NamespaceValue`	`PORTAL_TALK` The "Portal talk" namespace for the current language.
`Namespace.NamespaceValue`	`PROJECT` The "Meta" namespace for the current language.
`Namespace.NamespaceValue`	`PROJECT_TALK` The "Meta talk" namespace for the current language.
`Namespace.NamespaceValue`	`SPECIAL` The "Special" namespace for the current language.
`Namespace.NamespaceValue`	`TALK` The "Talk" namespace for the current language.
`Namespace.NamespaceValue`	`TEMPLATE` The "Template" namespace for the current language.
`Namespace.NamespaceValue`	`TEMPLATE_TALK` The "Template talk" namespace for the current language.
`Namespace.NamespaceValue`	`TIMEDTEXT`
`Namespace.NamespaceValue`	`TIMEDTEXT_TALK`
`Namespace.NamespaceValue`	`TOPIC`
`Namespace.NamespaceValue`	`USER` The "User" namespace for the current language.
`Namespace.NamespaceValue`	`USER_TALK` The "User talk" namespace for the current language.

Constructor Summary

Constructors
Constructor and Description

Namespace()

Namespace(Locale locale)

Namespace(ResourceBundle resourceBundle)

Constructors
Constructor and Description
`Namespace()`
`Namespace(Locale locale)`
`Namespace(ResourceBundle resourceBundle)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`extractFromResource(ResourceBundle resource, Namespace.ExtractType cmd)`
`INamespace.INamespaceValue`	`getCategory_talk()` The "Category talk" namespace for the current language.
`INamespace.INamespaceValue`	`getCategory()` The "Category" namespace for the current language.
`Namespace.NamespaceValue`	`getContentspace(String talkNamespace)` Gets the content namespace for a given (talk) namespace.
`INamespace.INamespaceValue`	`getHelp_talk()` The "Help talk" namespace for the current language.
`INamespace.INamespaceValue`	`getHelp()` The "Help" namespace for the current language.
`INamespace.INamespaceValue`	`getImage_talk()` The "File talk" namespace for the current language.
`INamespace.INamespaceValue`	`getImage()` The "File" namespace for the current language.
`INamespace.INamespaceValue`	`getMain()` The main namespace for the current language.
`INamespace.INamespaceValue`	`getMedia()` Get the "Media" namespace for the current language.
`INamespace.INamespaceValue`	`getMediaWiki_talk()` The "MediaWiki talk" namespace for the current language.
`INamespace.INamespaceValue`	`getMediaWiki()` The "MediaWiki" namespace for the current language.
`INamespace.INamespaceValue`	`getModule()` The "Module" namespace for the current language.
`Namespace.NamespaceValue`	`getNamespace(String namespace)`
`Namespace.NamespaceValue`	`getNamespaceByNumber(INamespace.NamespaceCode numberCode)`
`Namespace.NamespaceValue`	`getNamespaceByNumber(int numberCode)`
`INamespace.INamespaceValue`	`getPortal_talk()` The "Portal talk" namespace for the current language.
`INamespace.INamespaceValue`	`getPortal()` The "Portal" namespace for the current language.
`INamespace.INamespaceValue`	`getProject_talk()` The "Meta talk" namespace for the current language.
`INamespace.INamespaceValue`	`getProject()` The "Meta" namespace for the current language.
`ResourceBundle`	`getResourceBundle()`
`INamespace.INamespaceValue`	`getSpecial()` Get the "Special" namespace for the current language.
`INamespace.INamespaceValue`	`getTalk()` The "Talk" namespace for the current language.
`Namespace.NamespaceValue`	`getTalkspace(String namespace)` Get the Talk namespace.
`INamespace.INamespaceValue`	`getTemplate_talk()` The "Template talk" namespace for the current language.
`INamespace.INamespaceValue`	`getTemplate()` The "Template" namespace for the current language.
`INamespace.INamespaceValue`	`getUser_talk()` The "User talk" namespace for the current language.
`INamespace.INamespaceValue`	`getUser()` The "User" namespace for the current language.
`boolean`	`isNamespace(INamespace.INamespaceValue namespace, INamespace.NamespaceCode code)` Checks whether the given namespace is a namespace of the given type.
`boolean`	`isNamespace(String namespace, INamespace.NamespaceCode code)` Checks whether the given string is a valid namespace of the given type.
`String[]`	`splitNsTitle(String fullTitle)` Splits the given full title into its namespace and page title components and normalises both components using `Encoder.normaliseTitle(String, boolean, char, boolean)`.
`String[]`	`splitNsTitle(String fullTitle, boolean underScoreIsWhitespace, char whiteSpaceChar, boolean firstCharacterAsUpperCase)` Splits the given full title into its namespace and page title components and normalises both components using `Encoder.normaliseTitle(String, boolean, char, boolean)`.

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

- Field Detail
  - MEDIA
```
public final Namespace.NamespaceValue MEDIA
```
    The "Media" namespace for the current language.
  - SPECIAL
```
public final Namespace.NamespaceValue SPECIAL
```
    The "Special" namespace for the current language.
  - TALK
```
public final Namespace.NamespaceValue TALK
```
    The "Talk" namespace for the current language.
  - MAIN
```
public final Namespace.NamespaceValue MAIN
```
    The main namespace for the current language.
  - USER_TALK
```
public final Namespace.NamespaceValue USER_TALK
```
    The "User talk" namespace for the current language.
  - USER
```
public final Namespace.NamespaceValue USER
```
    The "User" namespace for the current language.
  - PROJECT_TALK
```
public final Namespace.NamespaceValue PROJECT_TALK
```
    The "Meta talk" namespace for the current language.
  - PROJECT
```
public final Namespace.NamespaceValue PROJECT
```
    The "Meta" namespace for the current language.
  - IMAGE_TALK
```
public final Namespace.NamespaceValue IMAGE_TALK
```
    NS_IMAGE and NS_IMAGE_TALK are the pre-v1.14 names for NS_FILE and NS_FILE_TALK respectively, and are kept for compatibility.
  - IMAGE
```
public final Namespace.NamespaceValue IMAGE
```
  - MEDIAWIKI_TALK
```
public final Namespace.NamespaceValue MEDIAWIKI_TALK
```
    The "MediaWiki talk" namespace for the current language.
  - MEDIAWIKI
```
public final Namespace.NamespaceValue MEDIAWIKI
```
    The "MediaWiki" namespace for the current language.
  - MODULE_TALK
```
public final Namespace.NamespaceValue MODULE_TALK
```
    The "Module talk" namespace for the current language.
  - MODULE
```
public final Namespace.NamespaceValue MODULE
```
    The "Module" namespace for the current language.
  - TEMPLATE_TALK
```
public final Namespace.NamespaceValue TEMPLATE_TALK
```
    The "Template talk" namespace for the current language.
  - TEMPLATE
```
public final Namespace.NamespaceValue TEMPLATE
```
    The "Template" namespace for the current language.
  - HELP_TALK
```
public final Namespace.NamespaceValue HELP_TALK
```
    The "Help talk" namespace for the current language.
  - HELP
```
public final Namespace.NamespaceValue HELP
```
    The "Help" namespace for the current language.
  - CATEGORY_TALK
```
public final Namespace.NamespaceValue CATEGORY_TALK
```
    The "Category talk" namespace for the current language.
  - CATEGORY
```
public final Namespace.NamespaceValue CATEGORY
```
    The "Category" namespace for the current language.
  - PORTAL_TALK
```
public final Namespace.NamespaceValue PORTAL_TALK
```
    The "Portal talk" namespace for the current language.
  - PORTAL
```
public final Namespace.NamespaceValue PORTAL
```
    The "Portal" namespace for the current language.
  - BOOK_TALK
```
public final Namespace.NamespaceValue BOOK_TALK
```
  - BOOK
```
public final Namespace.NamespaceValue BOOK
```
  - DRAFT_TALK
```
public final Namespace.NamespaceValue DRAFT_TALK
```
  - DRAFT
```
public final Namespace.NamespaceValue DRAFT
```
  - EP_TALK
```
public final Namespace.NamespaceValue EP_TALK
```
  - EP
```
public final Namespace.NamespaceValue EP
```
  - TIMEDTEXT_TALK
```
public final Namespace.NamespaceValue TIMEDTEXT_TALK
```
  - TIMEDTEXT
```
public final Namespace.NamespaceValue TIMEDTEXT
```
  - TOPIC
```
public final Namespace.NamespaceValue TOPIC
```
  - fResourceBundle
```
protected ResourceBundle fResourceBundle
```
  - fResourceBundleEn
```
protected ResourceBundle fResourceBundleEn
```
- Constructor Detail
  - Namespace
```
public Namespace()
```
  - Namespace
```
public Namespace(Locale locale)
```
  - Namespace
```
public Namespace(ResourceBundle resourceBundle)
```
- Method Detail
  - isNamespace
```
public boolean isNamespace(String namespace,
                           INamespace.NamespaceCode code)
```
    Description copied from interface: INamespace
    
    Checks whether the given string is a valid namespace of the given type.
    
    Specified by:
    
    isNamespace in interface INamespace
    
    Parameters:
    
    namespace - the potential namespace string
    
    code - the code
    
    Returns:
    
    true if the given namespace is of the given code, false otherwise
  - isNamespace
```
public boolean isNamespace(INamespace.INamespaceValue namespace,
                           INamespace.NamespaceCode code)
```
    Description copied from interface: INamespace
    
    Checks whether the given namespace is a namespace of the given type.
    
    Specified by:
    
    isNamespace in interface INamespace
    
    Parameters:
    
    namespace - the namespace
    
    code - the code
    
    Returns:
    
    true if the given namespace is of the given code, false otherwise
  - getNamespace
```
@Nullable
public Namespace.NamespaceValue getNamespace(String namespace)
```
    Specified by:
    
    getNamespace in interface INamespace
  - getNamespaceByNumber
```
public Namespace.NamespaceValue getNamespaceByNumber(INamespace.NamespaceCode numberCode)
```
    Specified by:
    
    getNamespaceByNumber in interface INamespace
  - getNamespaceByNumber
```
@Nullable
public Namespace.NamespaceValue getNamespaceByNumber(int numberCode)
```
    Specified by:
    
    getNamespaceByNumber in interface INamespace
  - getResourceBundle
```
public ResourceBundle getResourceBundle()
```
    Specified by:
    
    getResourceBundle in interface INamespace
  - extractFromResource
```
protected void extractFromResource(ResourceBundle resource,
                                   Namespace.ExtractType cmd)
```
  - getTalkspace
```
public Namespace.NamespaceValue getTalkspace(String namespace)
```
    Description copied from interface: INamespace
    
    Get the Talk namespace.
    
    Specified by:
    
    getTalkspace in interface INamespace
    
    Parameters:
    
    namespace - the namespace
    
    Returns:
    
    the talk namespace for the given namespace or null if the namespace is invalid or there is no talk namespace
    
    See Also:
    
    INamespace.getContentspace(String)
  - getContentspace
```
public Namespace.NamespaceValue getContentspace(String talkNamespace)
```
    Description copied from interface: INamespace
    
    Gets the content namespace for a given (talk) namespace.
    
    Specified by:
    
    getContentspace in interface INamespace
    
    Parameters:
    
    talkNamespace - the namespace, potentially a talkspace
    
    Returns:
    
    the content namespace or null
    
    See Also:
    
    INamespace.getTalkspace(String)
  - getMedia
```
public INamespace.INamespaceValue getMedia()
```
    Description copied from interface: INamespace
    
    Get the "Media" namespace for the current language.
    
    Specified by:
    
    getMedia in interface INamespace
    
    Returns:
    
    the namespace
  - getSpecial
```
public INamespace.INamespaceValue getSpecial()
```
    Description copied from interface: INamespace
    
    Get the "Special" namespace for the current language.
    
    Specified by:
    
    getSpecial in interface INamespace
    
    Returns:
    
    the namespace
  - getMain
```
public INamespace.INamespaceValue getMain()
```
    Description copied from interface: INamespace
    
    The main namespace for the current language.
    
    Specified by:
    
    getMain in interface INamespace
    
    Returns:
    
    the namespace
  - getTalk
```
public INamespace.INamespaceValue getTalk()
```
    Description copied from interface: INamespace
    
    The "Talk" namespace for the current language.
    
    Specified by:
    
    getTalk in interface INamespace
    
    Returns:
    
    the namespace
  - getUser
```
public INamespace.INamespaceValue getUser()
```
    Description copied from interface: INamespace
    
    The "User" namespace for the current language.
    
    Specified by:
    
    getUser in interface INamespace
    
    Returns:
    
    the namespace
  - getUser_talk
```
public INamespace.INamespaceValue getUser_talk()
```
    Description copied from interface: INamespace
    
    The "User talk" namespace for the current language.
    
    Specified by:
    
    getUser_talk in interface INamespace
    
    Returns:
    
    the namespace
  - getProject
```
public INamespace.INamespaceValue getProject()
```
    Description copied from interface: INamespace
    
    The "Meta" namespace for the current language.
    
    Specified by:
    
    getProject in interface INamespace
    
    Returns:
    
    the namespace
  - getProject_talk
```
public INamespace.INamespaceValue getProject_talk()
```
    Description copied from interface: INamespace
    
    The "Meta talk" namespace for the current language.
    
    Specified by:
    
    getProject_talk in interface INamespace
    
    Returns:
    
    the namespace
  - getImage
```
public INamespace.INamespaceValue getImage()
```
    Description copied from interface: INamespace
    
    The "File" namespace for the current language.
    
    Specified by:
    
    getImage in interface INamespace
    
    Returns:
    
    the namespace
  - getImage_talk
```
public INamespace.INamespaceValue getImage_talk()
```
    Description copied from interface: INamespace
    
    The "File talk" namespace for the current language.
    
    Specified by:
    
    getImage_talk in interface INamespace
    
    Returns:
    
    the namespace
  - getMediaWiki
```
public INamespace.INamespaceValue getMediaWiki()
```
    Description copied from interface: INamespace
    
    The "MediaWiki" namespace for the current language.
    
    Specified by:
    
    getMediaWiki in interface INamespace
    
    Returns:
    
    the namespace
  - getMediaWiki_talk
```
public INamespace.INamespaceValue getMediaWiki_talk()
```
    Description copied from interface: INamespace
    
    The "MediaWiki talk" namespace for the current language.
    
    Specified by:
    
    getMediaWiki_talk in interface INamespace
    
    Returns:
    
    the namespace
  - getModule
```
public INamespace.INamespaceValue getModule()
```
    Description copied from interface: INamespace
    
    The "Module" namespace for the current language.
    
    Specified by:
    
    getModule in interface INamespace
    
    Returns:
    
    the namespace
  - getTemplate
```
public INamespace.INamespaceValue getTemplate()
```
    Description copied from interface: INamespace
    
    The "Template" namespace for the current language.
    
    Specified by:
    
    getTemplate in interface INamespace
    
    Returns:
    
    the namespace
  - getTemplate_talk
```
public INamespace.INamespaceValue getTemplate_talk()
```
    Description copied from interface: INamespace
    
    The "Template talk" namespace for the current language.
    
    Specified by:
    
    getTemplate_talk in interface INamespace
    
    Returns:
    
    the namespace
  - getHelp
```
public INamespace.INamespaceValue getHelp()
```
    Description copied from interface: INamespace
    
    The "Help" namespace for the current language.
    
    Specified by:
    
    getHelp in interface INamespace
    
    Returns:
    
    the namespace
  - getHelp_talk
```
public INamespace.INamespaceValue getHelp_talk()
```
    Description copied from interface: INamespace
    
    The "Help talk" namespace for the current language.
    
    Specified by:
    
    getHelp_talk in interface INamespace
    
    Returns:
    
    the namespace
  - getCategory
```
public INamespace.INamespaceValue getCategory()
```
    Description copied from interface: INamespace
    
    The "Category" namespace for the current language.
    
    Specified by:
    
    getCategory in interface INamespace
    
    Returns:
    
    the namespace
  - getCategory_talk
```
public INamespace.INamespaceValue getCategory_talk()
```
    Description copied from interface: INamespace
    
    The "Category talk" namespace for the current language.
    
    Specified by:
    
    getCategory_talk in interface INamespace
  - getPortal
```
public INamespace.INamespaceValue getPortal()
```
    Description copied from interface: INamespace
    
    The "Portal" namespace for the current language.
    
    Specified by:
    
    getPortal in interface INamespace
    
    Returns:
    
    the namespace
  - getPortal_talk
```
public INamespace.INamespaceValue getPortal_talk()
```
    Description copied from interface: INamespace
    
    The "Portal talk" namespace for the current language.
    
    Specified by:
    
    getPortal_talk in interface INamespace
  - splitNsTitle
```
public String[] splitNsTitle(String fullTitle)
```
    Description copied from interface: INamespace
    
    Splits the given full title into its namespace and page title components and normalises both components using Encoder.normaliseTitle(String, boolean, char, boolean). Assumes underScoreIsWhitespace, uses a space as whiteSpaceChar and capitalises the first character.
    
    Specified by:
    
    splitNsTitle in interface INamespace
    
    Parameters:
    
    fullTitle - the (full) title including a namespace (if present)
    
    Returns:
    
    a 2-element array with the raw namespace string (index 0) and the page title (index 1)
    
    See Also:
    
    INamespace.splitNsTitle(String, boolean, char, boolean)
  - splitNsTitle
```
public String[] splitNsTitle(String fullTitle,
                             boolean underScoreIsWhitespace,
                             char whiteSpaceChar,
                             boolean firstCharacterAsUpperCase)
```
    Description copied from interface: INamespace
    
    Splits the given full title into its namespace and page title components and normalises both components using Encoder.normaliseTitle(String, boolean, char, boolean).
    
    Specified by:
    
    splitNsTitle in interface INamespace
    
    Parameters:
    
    fullTitle - the (full) title including a namespace (if present)
    
    underScoreIsWhitespace - whether '_' should be seen as whitespace or not
    
    whiteSpaceChar - the character to replace whitespace with
    
    firstCharacterAsUpperCase - if true convert the first of the title to upper case
    
    Returns:
    
    a 2-element array with the raw namespace string (index 0) and the page title (index 1)

Class Namespace

Nested Class Summary

Nested classes/interfaces inherited from interface info.bliki.wiki.namespaces.INamespace

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MEDIA

SPECIAL

TALK

MAIN

USER_TALK

USER

PROJECT_TALK

PROJECT

IMAGE_TALK

IMAGE

MEDIAWIKI_TALK

MEDIAWIKI

MODULE_TALK

MODULE

TEMPLATE_TALK

TEMPLATE

HELP_TALK

HELP

CATEGORY_TALK

CATEGORY

PORTAL_TALK

PORTAL

BOOK_TALK

BOOK

DRAFT_TALK

DRAFT

EP_TALK

EP

TIMEDTEXT_TALK

TIMEDTEXT

TOPIC

fResourceBundle

fResourceBundleEn

Constructor Detail

Namespace

Namespace

Namespace

Method Detail

isNamespace

isNamespace

getNamespace

getNamespaceByNumber

getNamespaceByNumber

getResourceBundle

extractFromResource

getTalkspace

getContentspace

getMedia

getSpecial

getMain

getTalk

getUser

getUser_talk

getProject

getProject_talk

getImage

getImage_talk

getMediaWiki

getMediaWiki_talk

getModule

getTemplate

getTemplate_talk

getHelp

getHelp_talk

getCategory

getCategory_talk

getPortal

getPortal_talk

splitNsTitle

splitNsTitle