org.uberfire.mvp.impl

Class DefaultPlaceRequest

java.lang.Object

org.uberfire.mvp.impl.DefaultPlaceRequest

All Implemented Interfaces:

PlaceRequest

Direct Known Subclasses:

ConditionalPlaceRequest, ExternalPathPlaceRequest, ForcedPlaceRequest, PathPlaceRequest

@Portable
public class DefaultPlaceRequest
extends Object
implements PlaceRequest

Field Summary

Fields

Modifier and Type	Field and Description
protected String	identifier
protected Map<String,String>	parameters

Fields inherited from interface org.uberfire.mvp.PlaceRequest

NOWHERE

Constructor Summary

Constructors

Constructor and Description
DefaultPlaceRequest()
DefaultPlaceRequest(String identifier) Creates a place request for the given place ID.
DefaultPlaceRequest(String identifier, Map<String,String> parameters) Creates a place request for the given place ID with the given state parameters for that place.
DefaultPlaceRequest(String identifier, Map<String,String> parameters, boolean updateLocationBar) Creates a place request for the given place ID, with the given state parameters for that place, and the given preference of whether or not the browser's location bar should be updated.

Method Summary

Modifier and Type	Method and Description
PlaceRequest	addParameter(String name, String value)
PlaceRequest	clone()
boolean	equals(Object o)
String	getFullIdentifier()
String	getIdentifier()
String	getParameter(String key, String defaultValue)
Set<String>	getParameterNames()
Map<String,String>	getParameters()
int	hashCode()
boolean	isUpdateLocationBarAllowed() Indicates whether or not the Workbench framework should add a browser history item when navigating to this place.
static PlaceRequest	parse(CharSequence partNameAndParams) Creates a new place request from a string that encodes a place ID and optional parameters in standard URL query syntax.
void	setIdentifier(String identifier)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.uberfire.mvp.PlaceRequest

asString, getPath

Field Detail

identifier

protected String identifier

parameters

protected final Map<String,String> parameters

Constructor Detail

DefaultPlaceRequest

public DefaultPlaceRequest()

DefaultPlaceRequest

public DefaultPlaceRequest(String identifier)

Creates a place request for the given place ID.

Parameters:

identifier - The place ID, or an empty string for the default place.

DefaultPlaceRequest

public DefaultPlaceRequest(String identifier,
                           Map<String,String> parameters)

Creates a place request for the given place ID with the given state parameters for that place.

Parameters:

identifier - The place ID, or an empty string for the default place.

parameters - Place-specific parameters to pass to the place. Must not be null.

DefaultPlaceRequest

public DefaultPlaceRequest(String identifier,
                           Map<String,String> parameters,
                           boolean updateLocationBar)

Creates a place request for the given place ID, with the given state parameters for that place, and the given preference of whether or not the browser's location bar should be updated.

Parameters:

identifier - The place ID, or an empty string for the default place.

parameters - Place-specific parameters to pass to the place. Must not be null.

updateLocationBar - If true, the browser's history will be updated with this place request. If false, the location bar will not be modified as a result of this place request.

Method Detail

parse

public static PlaceRequest parse(CharSequence partNameAndParams)

Creates a new place request from a string that encodes a place ID and optional parameters in standard URL query syntax.

For example, the following returns a PlaceRequest with identifier MyPlaceID and two parameters, param1 and param2.

   DefaultPlaceRequest.parse("MyPlaceID?param1=val1&param2=val2")
 

Parameters:

partNameAndParams - specification of the place ID and optional parameter map. Special characters in the identifier, key name, or key value can be escaped using URL encoding: for '%' use '%25'; for '&' use '%26'; for '=' use '%3d'; for '?' use '%3f'.

Returns:

a new PlaceRequest configured according to the given string.

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface PlaceRequest

setIdentifier

public void setIdentifier(String identifier)

Specified by:

setIdentifier in interface PlaceRequest

getFullIdentifier

public String getFullIdentifier()

Specified by:

getFullIdentifier in interface PlaceRequest

getParameter

public String getParameter(String key,
                           String defaultValue)

Specified by:

getParameter in interface PlaceRequest

getParameterNames

public Set<String> getParameterNames()

Specified by:

getParameterNames in interface PlaceRequest

getParameters

public Map<String,String> getParameters()

Specified by:

getParameters in interface PlaceRequest

addParameter

public PlaceRequest addParameter(String name,
                                 String value)

Specified by:

addParameter in interface PlaceRequest

clone

public PlaceRequest clone()

Specified by:

clone in interface PlaceRequest

Overrides:

clone in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

isUpdateLocationBarAllowed

public boolean isUpdateLocationBarAllowed()

Description copied from interface: PlaceRequest

Indicates whether or not the Workbench framework should add a browser history item when navigating to this place.

Specified by:

isUpdateLocationBarAllowed in interface PlaceRequest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object