Package com.helger.photon.api.pathdescriptor

Class PathDescriptor

java.lang.Object

com.helger.photon.api.pathdescriptor.PathDescriptor

All Implemented Interfaces:

Serializable

@Immutable
public final class PathDescriptor
extends Object
implements Serializable

This class keeps a list of PathDescriptorPart objects that are created when initially parsing an API path. It consists of plain string parts as well as of dynamic (variable) parts.

Author:

Philip Helger

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	containsVariables()
static PathDescriptor	create(String sPath)
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsList<PathDescriptorPart>	getAllParts()
String	getAsURLString()
int	hashCode()
PathMatchingResult	matchesParts(List<String> aPathParts)	Check if this path descriptor matches the provided path parts.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getAllParts

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<PathDescriptorPart> getAllParts()

matchesParts

@Nonnull
public PathMatchingResult matchesParts(@Nonnull
                                       List<String> aPathParts)

Check if this path descriptor matches the provided path parts. This requires that this path descriptor and the provided collection have the same number of elements and that all static and variable parts match.

Parameters:

aPathParts - The parts to

Returns:

A non-null PathMatchingResult object with all matching variable names.

getAsURLString

@Nonnull
@Nonempty
public String getAsURLString()

containsVariables

public boolean containsVariables()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
public static PathDescriptor create(@Nonnull @Nonempty
                                    String sPath)