info.bliki.wiki.filter

Class ParsedPageName

java.lang.Object

info.bliki.wiki.filter.ParsedPageName

public class ParsedPageName
extends Object

Represents the result of parsing a (potential) page name. Note that magicWord takes precedence over pagename, i.e. if magicWord if not null, the parsed name is a magic word!

Author:

Nico Kruber, kruber@zib.de

Field Summary

Fields

Modifier and Type	Field and Description
Object	magicWord If the pagename was a magic word it will be this, otherwise null.
String	magicWordParameter Parameters of the magic word (null if not supplied).
INamespace.INamespaceValue	namespace The namespace the page is in.
String	pagename The name of the page (without the namespace).
boolean	valid Whether this pagename was successfully parsed or not.

Constructor Summary

Constructors

Constructor and Description
ParsedPageName(INamespace.INamespaceValue namespace, String pagename, boolean valid) Creates a new parsed page name object (no magic word).
ParsedPageName(INamespace.INamespaceValue namespace, String pagename, Object magicWord, String magicWordParameter, boolean valid) Creates a new parsed page name object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	fullPagename()
int	hashCode()
static ParsedPageName	parsePageName(IWikiModel wikiModel, String pagename, INamespace.INamespaceValue namespace, boolean magicWordAllowed, boolean stripOffSection) Parses a given page name into its components, e.g.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

namespace

public final INamespace.INamespaceValue namespace

The namespace the page is in.

pagename

public final String pagename

The name of the page (without the namespace).

valid

public final boolean valid

Whether this pagename was successfully parsed or not.

magicWord

public final Object magicWord

If the pagename was a magic word it will be this, otherwise null. The object type depends on the concrete MagicWord implementation used by the IWikiModel, e.g. MagicWord.MagicWordE in case MagicWord is used.

magicWordParameter

public final String magicWordParameter

Parameters of the magic word (null if not supplied).

Constructor Detail

ParsedPageName

public ParsedPageName(INamespace.INamespaceValue namespace,
                      String pagename,
                      boolean valid)

Creates a new parsed page name object (no magic word).

Parameters:

namespace - the namespace the page is in

pagename - the name of the page (without the namespace)

valid - whether this pagename was successfully parsed or not

ParsedPageName

public ParsedPageName(INamespace.INamespaceValue namespace,
                      String pagename,
                      Object magicWord,
                      String magicWordParameter,
                      boolean valid)

Creates a new parsed page name object.

Parameters:

namespace - the namespace the page is in

pagename - the name of the page (without the namespace)

magicWord - the magic word object if the pagename was a magic word, otherwise null

magicWordParameter - parameters of the magic word (null if not supplied)

valid - whether this pagename was successfully parsed or not

Method Detail

parsePageName

@Nonnull
public static ParsedPageName parsePageName(@Nonnull
                                                    IWikiModel wikiModel,
                                                    @Nonnull
                                                    String pagename,
                                                    INamespace.INamespaceValue namespace,
                                                    boolean magicWordAllowed,
                                                    boolean stripOffSection)

Parses a given page name into its components, e.g. namespace and pagename or magic word and parameters.

Parameters:

wikiModel - the wiki model to use

pagename - the name in wiki text

namespace - the default namespace to use if there is no namespace in the pagename

magicWordAllowed - whether the pagename may be a magic word or not (if it is a magic word and this is set to false, it will be parsed as if it is a page name)

Returns:

a parsed page name

toString

public String toString()

Overrides:

toString in class Object

fullPagename

public String fullPagename()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object