org.ocpsoft.rewrite.faces.navigate

Class Navigate

java.lang.Object

org.ocpsoft.rewrite.faces.navigate.Navigate

public class Navigate
extends Object

Helper class to build JSF action outcomes.

Author:

Christian Kaltepoth

Method Summary

Methods

Modifier and Type	Method and Description
String	build() Build and return the fully constructed navigation String.
static Navigate	to(Class<?> clazz) Create a new Navigate instance that will invoke navigation to the specified Class.
static Navigate	to(String viewId) Create a new Navigate instance that will invoke navigation to the specified View ID.
String	toString()
Navigate	with(CharSequence name, Object value) Set a query parameter to be passed to the specified View Id.
Navigate	withoutRedirect() Specify that navigation should be performed using JavaServer Faces non-redirecting navigation.

Methods inherited from class java.lang.Object

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

Method Detail

to

public static Navigate to(String viewId)

Create a new Navigate instance that will invoke navigation to the specified View ID.

Query parameters to be provided to the destination View ID may be supplied via with(CharSequence, Object).

Parameters:

viewId - the destination View ID

to

public static Navigate to(Class<?> clazz)

Create a new Navigate instance that will invoke navigation to the specified Class. For instance, if the class specifies a @Join rule, this would generate a navigation case targeting the Address for the defined resource.

Query parameters to be provided to the destination View ID may be supplied via with(CharSequence, Object).

Parameters:

clazz - the target Class

See Also:

ResourcePathResolver

with

public Navigate with(CharSequence name,
            Object value)

Set a query parameter to be passed to the specified View Id.

Parameters:

The - query parameter name.

The - query parameter value.

withoutRedirect

public Navigate withoutRedirect()

Specify that navigation should be performed using JavaServer Faces non-redirecting navigation.

build

public String build()

Build and return the fully constructed navigation String.

toString

public String toString()

Overrides:

toString in class Object