bb.io.filefilter
Enum PartMode

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

public enum PartMode
extends Enum<PartMode>

Enum of the different parts of a File's path which can be extracted and subjected to a filter's test.

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
name
          Specifies that only the name of the File will be subjected to the filter's test.
other
          Specifies that nothing will be extracted from the File because the filter operates differently (e.g. it uses the original File instance only).
path
          Specifies that the path of the File will be subjected to the filter's test.
 
Method Summary
static PartMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PartMode[] 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

name

public static final PartMode name
Specifies that only the name of the File will be subjected to the filter's test.


path

public static final PartMode path
Specifies that the path of the File will be subjected to the filter's test.


other

public static final PartMode other
Specifies that nothing will be extracted from the File because the filter operates differently (e.g. it uses the original File instance only).

Method Detail

values

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

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

valueOf

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