ch.grengine.sources

Enum DirMode

java.lang.Object

java.lang.Enum<DirMode>

ch.grengine.sources.DirMode

All Implemented Interfaces:

Serializable, Comparable<DirMode>

public enum DirMode
extends Enum<DirMode>

Mode for parsing directories for files.

Since:

1.0

Author:

Alain Stalder, Made in Switzerland.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static DirMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DirMode[]	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

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 Detail

values

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

Returns:

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

valueOf

public static DirMode 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