Package com.helger.photon.api.pathdescriptor

Class PathMatchingResult

java.lang.Object

com.helger.photon.api.pathdescriptor.PathMatchingResult

All Implemented Interfaces:

Serializable

public final class PathMatchingResult
extends Object
implements Serializable

This class represents the overall result of a path matching. Upon successful matching all variable path parts are returned as a map in the order of the path.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static PathMatchingResult	NO_MATCH

Constructor Summary

Constructors

Constructor	Description
PathMatchingResult(com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> aVariableValues)	Constructor for "match"

Method Summary

Modifier and Type	Method	Description
static PathMatchingResult	createSuccess(com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> aVariableValues)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAllVariableValues()
boolean	isMatch()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_MATCH

public static final PathMatchingResult NO_MATCH

Constructor Detail

PathMatchingResult

public PathMatchingResult(@Nonnull
                          com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> aVariableValues)

Constructor for "match"

Parameters:

aVariableValues - Non-null but may empty matching variables.

Method Detail

isMatch

public boolean isMatch()

Returns:

true if the path matching was successful, false otherwise.

getAllVariableValues

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getAllVariableValues()

toString

public String toString()

Overrides:

toString in class Object

createSuccess

@Nonnull
public static PathMatchingResult createSuccess(@Nonnull
                                               com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> aVariableValues)