com.github.wuic.nut.dao

Enum NutDao.PathFormat

java.lang.Object

java.lang.Enum<NutDao.PathFormat>

com.github.wuic.nut.dao.NutDao.PathFormat

All Implemented Interfaces:

Serializable, Comparable<NutDao.PathFormat>

Enclosing interface:

NutDao

public static enum NutDao.PathFormat
extends Enum<NutDao.PathFormat>

This enumeration specifies formats of path specified to create nuts.

Since:

0.4.2

Version:

1.0

Author:

Guillaume DROUET

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Any format.
RELATIVE_FILE Relative file format.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	canBeRegex() Indicates if this format could corresponds to a regex.
static NutDao.PathFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static NutDao.PathFormat[]	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

ANY

public static final NutDao.PathFormat ANY

Any format. We don't know anything of the format.

RELATIVE_FILE

public static final NutDao.PathFormat RELATIVE_FILE

Relative file format.

Method Detail

values

public static NutDao.PathFormat[] 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 (NutDao.PathFormat c : NutDao.PathFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static NutDao.PathFormat 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

canBeRegex

public Boolean canBeRegex()

Indicates if this format could corresponds to a regex.

Returns:

true is the value could corresponds to a regex, false otherwise