com.ocpsoft.pretty.faces.util

Class PrettyURLBuilder

java.lang.Object

com.ocpsoft.pretty.faces.util.PrettyURLBuilder

public class PrettyURLBuilder
extends Object

A utility class for building Pretty URLs.

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
PrettyURLBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
String	build(UrlMapping urlMapping, boolean encodeUrl, List<UIParameter> parameters) Build a Pretty URL for the given Mapping ID and parameters.
String	build(UrlMapping mapping, boolean encodeUrl, Map<String,String[]> parameters) Build a Pretty URL for the given UrlMapping and parameters.
String	build(UrlMapping mapping, boolean encodeUrl, Object... parameters) Build a Pretty URL for the given UrlMapping and parameters.
String	build(UrlMapping mapping, boolean encodeUrl, RequestParameter... parameters) Build a Pretty URL for the given UrlMapping and parameters.
String	build(UrlMapping urlMapping, List<UIParameter> parameters) Deprecated. Use build(UrlMapping, boolean, List) instead.
String	build(UrlMapping mapping, Map<String,String[]> parameters) Deprecated. Use build(UrlMapping, boolean, Map) instead.
String	build(UrlMapping mapping, Object... parameters) Deprecated. Use build(UrlMapping, boolean, Object...) instead.
String	build(UrlMapping mapping, RequestParameter... parameters) Deprecated. Use build(UrlMapping, boolean, RequestParameter...) instead.
List<UIParameter>	extractParameters(UIComponent component) Extract any UIParameter objects from a given component.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrettyURLBuilder

public PrettyURLBuilder()

Method Detail

extractParameters

public List<UIParameter> extractParameters(UIComponent component)

Extract any UIParameter objects from a given component. These parameters are what PrettyFaces uses to communicate with the JSF component tree

Parameters:

component -

Returns:

A list of UIParameter objects, or an empty list if no UIParameters were contained within the component children.

build

@Deprecated
public String build(UrlMapping mapping,
                      Map<String,String[]> parameters)

Deprecated. Use build(UrlMapping, boolean, Map) instead.

Build a Pretty URL for the given UrlMapping and parameters.

build

public String build(UrlMapping mapping,
           boolean encodeUrl,
           Map<String,String[]> parameters)

Build a Pretty URL for the given UrlMapping and parameters.

Since:

3.2.0

build

@Deprecated
public String build(UrlMapping mapping,
                      Object... parameters)

Deprecated. Use build(UrlMapping, boolean, Object...) instead.

Build a Pretty URL for the given UrlMapping and parameters.

build

public String build(UrlMapping mapping,
           boolean encodeUrl,
           Object... parameters)

Build a Pretty URL for the given UrlMapping and parameters.

Since:

3.2.0

build

@Deprecated
public String build(UrlMapping mapping,
                      RequestParameter... parameters)

Deprecated. Use build(UrlMapping, boolean, RequestParameter...) instead.

Build a Pretty URL for the given UrlMapping and parameters.

build

public String build(UrlMapping mapping,
           boolean encodeUrl,
           RequestParameter... parameters)

Build a Pretty URL for the given UrlMapping and parameters.

Since:

3.2.0

build

@Deprecated
public String build(UrlMapping urlMapping,
                      List<UIParameter> parameters)

Deprecated. Use build(UrlMapping, boolean, List) instead.

Build a Pretty URL for the given Mapping ID and parameters.

build

public String build(UrlMapping urlMapping,
           boolean encodeUrl,
           List<UIParameter> parameters)

Build a Pretty URL for the given Mapping ID and parameters.

Since:

3.2.0