Package com.helger.photon.api.pathdescriptor

Enum EPathDescriptorVariableConstraintType

java.lang.Object

java.lang.Enum<EPathDescriptorVariableConstraintType>

com.helger.photon.api.pathdescriptor.EPathDescriptorVariableConstraintType

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, Serializable, Comparable<EPathDescriptorVariableConstraintType>

public enum EPathDescriptorVariableConstraintType
extends Enum<EPathDescriptorVariableConstraintType>
implements com.helger.commons.id.IHasID<String>

This enum contains all the variable constraint types that can be used in API paths.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
REGEX

Method Summary

Modifier and Type	Method	Description
static EPathDescriptorVariableConstraintType	getFromIDOrNull(String sID)
String	getID()
boolean	isRequiresValue()
static EPathDescriptorVariableConstraintType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EPathDescriptorVariableConstraintType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REGEX

public static final EPathDescriptorVariableConstraintType REGEX

Method Detail

values

public static EPathDescriptorVariableConstraintType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EPathDescriptorVariableConstraintType c : EPathDescriptorVariableConstraintType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EPathDescriptorVariableConstraintType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

isRequiresValue

public boolean isRequiresValue()

getFromIDOrNull

@Nullable
public static EPathDescriptorVariableConstraintType getFromIDOrNull(@Nullable
                                                                    String sID)