com.ocpsoft.pretty.faces.url

Class URLPatternParser

java.lang.Object

com.ocpsoft.pretty.faces.url.URLPatternParser

public class URLPatternParser
extends Object

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
URLPatternParser(String pattern) Set the pattern for which this parser will match.

Method Summary

Methods

Modifier and Type	Method and Description
URL	getMappedURL(Object... params) URL encoding/decoding is not a concern of this method.
int	getParameterCount() Get the number of URL parameters that this parser expects to find in any given input string
List<PathParameter>	getPathParameters() Return the list of parameters specified by this pattern.
Object	getPattern()
boolean	isElPattern()
boolean	matches(String target) Deprecated.
boolean	matches(URL target) Return true if this parser matches the given URL, otherwise, return false.
List<PathParameter>	parse(URL url) Builds a list of PathParameters for this UrlPattern, extracted from the provided URL (assuming a match is found).

Methods inherited from class java.lang.Object

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

Constructor Detail

URLPatternParser

public URLPatternParser(String pattern)

Set the pattern for which this parser will match. Find and replace all el expressions with regular expressions to extract values from parsed URLs. Also extract all parameter names from expressions, and replace with valid EL

Parameters:

pattern - Pattern to use as a parse template

Method Detail

matches

public boolean matches(URL target)

Return true if this parser matches the given URL, otherwise, return false.

matches

@Deprecated
public boolean matches(String target)

Deprecated.

Return true if this parser matches the given URL, otherwise, return false.

getPathParameters

public List<PathParameter> getPathParameters()

Return the list of parameters specified by this pattern.

parse

public List<PathParameter> parse(URL url)

Builds a list of PathParameters for this UrlPattern, extracted from the provided URL (assuming a match is found). This list excludes duplicate named parameters.

getMappedURL

public URL getMappedURL(Object... params)

URL encoding/decoding is not a concern of this method.

Parameters:

params - Array of Object parameters, in order, to be substituted for mapping pattern values or el expressions. This method will call the toString() method on each object provided.

If only one param is specified and it is an instance of List, the list items will be used as parameters instead. An empty list or a single null parameter are both treated as if no parameters were specified.

E.g: getMappedUrl(12,55,"foo","bar") for a pattern of /#{el.one}/#{el.two}/#{el.three}/#{el.four}/ will return the String: "/12/55/foo/bar/"

Returns:

A URL based on this object's urlPatten, with values substituted for el expressions in the order provided

getParameterCount

public int getParameterCount()

Get the number of URL parameters that this parser expects to find in any given input string

Returns:

Number of parameters

getPattern

public Object getPattern()

isElPattern

public boolean isElPattern()

Returns:

whether the URL pattern is an expression language