PathDescriptorPart (ph-oton-api 9.1.1 API)

java.lang.Object
- com.helger.photon.api.pathdescriptor.PathDescriptorPart

All Implemented Interfaces:

Serializable
```
@Immutable
public final class PathDescriptorPart
extends Object
implements Serializable
```
This class keeps a single path part. This can be either a static string or a variable argument with optional constraints.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static char CONSTRAINT_SEPARATOR

static String VARIABLE_END

static String VARIABLE_START

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PathDescriptorPart`	`create(String sPathPart)`
`boolean`	`equals(Object o)`
`com.helger.commons.collection.impl.ICommonsList<PathDescriptorVariableConstraint>`	`getAllVariableConstraints()`
`String`	`getAsURLString()`
`String`	`getName()`
`static String`	`getVariableName(String sName)`
`int`	`hashCode()`
`boolean`	`isVariable()`
`boolean`	`matches(String sPathPart)`	Check if the passed path part matches the requirements of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- VARIABLE_START
```
public static final String VARIABLE_START
```
  See Also:
  
  Constant Field Values
- VARIABLE_END
```
public static final String VARIABLE_END
```
  See Also:
  
  Constant Field Values
- CONSTRAINT_SEPARATOR
```
public static final char CONSTRAINT_SEPARATOR
```
  See Also:
  
  Constant Field Values

Method Detail

isVariable
```
public boolean isVariable()
```
Returns:

true if this is variable path part, false if it is static

getName
```
@Nonnull
@Nonempty
public String getName()
```
Returns:

Either the static string or the name of the variable. Neither null nor empty.

getAllVariableConstraints
```
@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<PathDescriptorVariableConstraint> getAllVariableConstraints()
```
Returns:

The optional variable constraints. Only relevant if this is a variable path part. Never null but maybe empty.

matches
```
public boolean matches(@Nonnull
                       String sPathPart)
```
Check if the passed path part matches the requirements of this object. If this is a static path part, it's a simple string equals. For variable path parts, all the constraints (if any) must be fulfilled.

Parameters:

sPathPart - The string to be checked.

Returns:

true if the passed string matches, false otherwise.

getAsURLString

@Nonnull
@Nonempty
public String getAsURLString()

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

getVariableName

@Nonnull
@Nonempty
public static String getVariableName(@Nonnull @Nonempty
                                     String sName)

create

@Nonnull
public static PathDescriptorPart create(@Nonnull @Nonempty
                                        String sPathPart)