io.crysknife.ui.navigation.client.local

Class URLPatternMatcher

java.lang.Object

io.crysknife.ui.navigation.client.local.URLPatternMatcher

public class URLPatternMatcher
extends Object

Used to match URLs typed in by the user to the correct Page.path()

Author:

Max Barkley , Divya Dadlani

Constructor Summary

Constructors

Constructor and Description
URLPatternMatcher()

Method Summary

Modifier and Type	Method and Description
void	add(String urlTemplate, String pageName) Adds the allowed URL template as specified in the Page.path() by the developer.
static URLPattern	generatePattern(String urlTemplate) Generates a URLPattern from a Page.path()
String	getPageName(String typedURL)
URLPattern	getURLPattern(String pageName)
HistoryToken	parseURL(String url) Creates a HistoryToken by parsing a URL path.
void	setAsDefaultPage(String defaultPage) Declares the default page to be matched against the empty string pattern.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

URLPatternMatcher

public URLPatternMatcher()

Method Detail

add

public void add(String urlTemplate,
                String pageName)

Adds the allowed URL template as specified in the Page.path() by the developer.

Parameters:

urlTemplate - The page URL pattern specified in the Page.path().

pageName - The name of the page.

generatePattern

public static URLPattern generatePattern(String urlTemplate)

Generates a URLPattern from a Page.path()

Parameters:

urlTemplate - The Page.path()

Returns:

A URLPattern used to match URLs

parseURL

public HistoryToken parseURL(String url)

Creates a HistoryToken by parsing a URL path. This path should never include the application context.

setAsDefaultPage

public void setAsDefaultPage(String defaultPage)

Declares the default page to be matched against the empty string pattern.

Parameters:

defaultPage - Never null. Must match a page that has already been added with add(String, String)

getURLPattern

public URLPattern getURLPattern(String pageName)

Parameters:

pageName - The name of the page corresponding to the URLPattern

Returns:

The URLPattern for the given page name.

getPageName

public String getPageName(String typedURL)

Returns:

The name of the page to which the given user-entered URL corresponds.