bb.io.filefilter
Enum FileMode

java.lang.Object
  extended by java.lang.Enum<FileMode>
      extended by bb.io.filefilter.FileMode
All Implemented Interfaces:
Serializable, Comparable<FileMode>

public enum FileMode
extends Enum<FileMode>

Enum of all the ways that normal files can be handled by a filter.

This enum is multithread safe: it is stateless (except for the enumeration of values, which are immutable).

Like all java enums, this enum is Comparable and Serializable.

Author:
Brent Boyer
See Also:
Enum documentation


Enum Constant Summary
accept
          Specifies that normal files will always be accepted.
reject
          Specifies that normal files will always be rejected.
test
          Specifies that normal files will be subjected to the filter's test.
 
Method Summary
static FileMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FileMode[] 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

accept

public static final FileMode accept
Specifies that normal files will always be accepted.


test

public static final FileMode test
Specifies that normal files will be subjected to the filter's test.


reject

public static final FileMode reject
Specifies that normal files will always be rejected.

Method Detail

values

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

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

valueOf

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