Package ch.grengine.sources

Enum Class DirMode

java.lang.Object

java.lang.Enum<DirMode>

ch.grengine.sources.DirMode

All Implemented Interfaces:

Serializable, Comparable<DirMode>, Constable

public enum DirMode
extends Enum<DirMode>

Mode for parsing directories for files.

Since:

1.0

Author:

Alain Stalder, Made in Switzerland.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_SUBDIRS	parse only just the given directory, but none of its subdirectories.
WITH_SUBDIRS_RECURSIVE	parse the given directory, plus recursively all of its subdirectories.

Method Summary

Modifier and Type	Method	Description
static DirMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DirMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_SUBDIRS

public static final DirMode NO_SUBDIRS

parse only just the given directory, but none of its subdirectories.

Since:

1.0

WITH_SUBDIRS_RECURSIVE

public static final DirMode WITH_SUBDIRS_RECURSIVE

parse the given directory, plus recursively all of its subdirectories.

Since:

1.0

Method Details

values

public static DirMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DirMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null