bb.io.filefilter
Enum OtherMode

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

public enum OtherMode
extends Enum<OtherMode>

Enum of all the ways that "other" file system elements can be handled by a filter.

There are three types of file system elements: normal files, directories, and "other". Here, a "other" file system element is one whose File returns false for both isFile and isDirectory.

Here are some ways that "other" file system elements can be encountered:

  1. if a new File instance is created, and its path refers to a non-existing file system element, then its isFile and isDirectory methods obviously must both return false
  2. as actual existing entities on certain operating systems and/or file systems. For example, on Windows/NTFS, every drive has a (usually hidden) folder called System Volume Information, and a File which points to it returns false for both its isFile and isDirectory methods. Have also seen a File which points to A:\ when a floppy drive is not present return false for both its isFile and isDirectory methods.

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 "other" file system elements will always be accepted.
reject
          Specifies that "other" file system elements will always be rejected.
test
          Specifies that "other" file system elements will be subjected to the filter's test.
 
Method Summary
static OtherMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static OtherMode[] 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 OtherMode accept
Specifies that "other" file system elements will always be accepted.


test

public static final OtherMode test
Specifies that "other" file system elements will be subjected to the filter's test.


reject

public static final OtherMode reject
Specifies that "other" file system elements will always be rejected.

Method Detail

values

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

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

valueOf

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