org.uberfire.mvp.impl

Class ConditionalPlaceRequest

java.lang.Object

org.uberfire.mvp.impl.DefaultPlaceRequest

org.uberfire.mvp.impl.ConditionalPlaceRequest

All Implemented Interfaces:

PlaceRequest

public class ConditionalPlaceRequest
extends DefaultPlaceRequest

Field Summary

Fields inherited from class org.uberfire.mvp.impl.DefaultPlaceRequest

identifier, parameters

Fields inherited from interface org.uberfire.mvp.PlaceRequest

NOWHERE

Constructor Summary

Constructors

Constructor and Description
ConditionalPlaceRequest()
ConditionalPlaceRequest(String identifier) A predicate applied to determine if this place request should be used or the alternative specified by #orElse
ConditionalPlaceRequest(String identifier, Map<String,String> parameters) Creates a conditional place request for the given place ID with the given state parameters for that place.

Method Summary

Modifier and Type	Method and Description
PlaceRequest	clone()
boolean	equals(Object o) A conditional place request should be resolved before being compared to another default place request.
String	getIdentifier()
Map<String,String>	getParameters()
int	hashCode()
PlaceRequest	orElse(PlaceRequest orElsePlaceRequest) Creates a place request for the given place ID with the given state parameters for that place.
protected PlaceRequest	resolve()
PlaceRequest	resolveConditionalPlaceRequest() Return the place request of this conditional PlaceRequest.
String	toString()
ConditionalPlaceRequest	when(Predicate<PlaceRequest> predicate) Creates a place request for the given place ID with the given state parameters for that place.

Methods inherited from class org.uberfire.mvp.impl.DefaultPlaceRequest

addParameter, getFullIdentifier, getParameter, getParameterNames, isUpdateLocationBarAllowed, parse, setIdentifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.uberfire.mvp.PlaceRequest

asString, getPath

Constructor Detail

ConditionalPlaceRequest

public ConditionalPlaceRequest()

ConditionalPlaceRequest

public ConditionalPlaceRequest(String identifier)

A predicate applied to determine if this place request should be used or the alternative specified by #orElse

Parameters:

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

ConditionalPlaceRequest

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

Creates a conditional 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.

Method Detail

when

public ConditionalPlaceRequest when(Predicate<PlaceRequest> predicate)

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

Parameters:

predicate - Represents if default place request should be used. If false, the place request will be orElsePlaceRequest.

orElse

public PlaceRequest orElse(PlaceRequest orElsePlaceRequest)

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

Parameters:

orElsePlaceRequest - alternative place request.

resolveConditionalPlaceRequest

public PlaceRequest resolveConditionalPlaceRequest()

Return the place request of this conditional PlaceRequest. If there is no predicate or orElsePlaceRequest returns the default place request.

resolve

protected PlaceRequest resolve()

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface PlaceRequest

Overrides:

getIdentifier in class DefaultPlaceRequest

getParameters

public Map<String,String> getParameters()

Specified by:

getParameters in interface PlaceRequest

Overrides:

getParameters in class DefaultPlaceRequest

clone

public PlaceRequest clone()

Specified by:

clone in interface PlaceRequest

Overrides:

clone in class DefaultPlaceRequest

equals

public boolean equals(Object o)

A conditional place request should be resolved before being compared to another default place request.

Overrides:

equals in class DefaultPlaceRequest

Parameters:

o - A default or conditional place request.

Returns:

True if the resolved conditional place request equals to the default place request or resolved conditional place request passed, and false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultPlaceRequest

toString

public String toString()

Overrides:

toString in class DefaultPlaceRequest