io.crysknife.ui.navigation.client.local

Class URLPattern

java.lang.Object

io.crysknife.ui.navigation.client.local.URLPattern

public class URLPattern
extends Object

Used to extract page state values from the URL path. This class generates a URL where the page state values are appropriately encoded for parsing. Thus the URL must be appropriately decoded. See @see URLPattern#decodeParsingCharacters() below.

Author:

Max Barkley , Divya Dadlani

Field Summary

Fields

Modifier and Type	Field and Description
static String	urlSafe A regular expression that we use to match a path parameter value.

Constructor Summary

Constructors

Constructor and Description
URLPattern(org.gwtproject.regexp.shared.RegExp regex, List<String> paramList, String urlTemplate)

Method Summary

Modifier and Type	Method and Description
List<String>	getParamList()
org.gwtproject.regexp.shared.RegExp	getRegex()
boolean	matches(String url)
String	printURL(ImmutableMultimap<String,String> state) Uses the state map to construct the encoded URL for this pattern.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

urlSafe

public static final String urlSafe

A regular expression that we use to match a path parameter value. Since the value can contain any characters, this regex matches everything. Any characters that we use for parsing will later be encoded.

See Also:

Constant Field Values

Constructor Detail

URLPattern

public URLPattern(org.gwtproject.regexp.shared.RegExp regex,
                  List<String> paramList,
                  String urlTemplate)

Method Detail

getParamList

public List<String> getParamList()

Returns:

A list of path parameter key names. Never null.

getRegex

public org.gwtproject.regexp.shared.RegExp getRegex()

Returns:

The regular expression used to match URLs.

matches

public boolean matches(String url)

Parameters:

url - This URL path should not contain the application context and should not contain a leading slash.

Returns:

True if this pattern matches the given URL path

printURL

public String printURL(ImmutableMultimap<String,String> state)

Uses the state map to construct the encoded URL for this pattern. Values in state that are not predefined path parameters (see getParamList()) will be appended as key-value pairs. Note that this method only encodes the URL in a format that can be parsed by parseURL().

Parameters:

state -

Returns:

The constructed URL path without the application context.

Throws:

IllegalStateException - If a path parameter is missing from the given state map.

toString

public String toString()

Overrides:

toString in class Object