info.bioinfweb.commons.io

Enum ContentExtensionFileFilter.TestStrategy

java.lang.Object

java.lang.Enum<ContentExtensionFileFilter.TestStrategy>

info.bioinfweb.commons.io.ContentExtensionFileFilter.TestStrategy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ContentExtensionFileFilter.TestStrategy>

Enclosing class:

ContentExtensionFileFilter

public static enum ContentExtensionFileFilter.TestStrategy
extends java.lang.Enum<ContentExtensionFileFilter.TestStrategy>

Determines the way instances of ContentExtensionFileFilter determine which files are valid.

Since:

2.0.0

Author:

Ben Stöver

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH Files will first be selected by their extension and those will additionally be tested by their content.
CONTENT Files will only be tested by their content.
EXTENSION Files will only be filtered by their extension.

Method Summary

Modifier and Type	Method and Description
static ContentExtensionFileFilter.TestStrategy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ContentExtensionFileFilter.TestStrategy[]	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

EXTENSION

public static final ContentExtensionFileFilter.TestStrategy EXTENSION

Files will only be filtered by their extension.

This option does not allow to distinguish between different file types, that may have the same extension, but is a lot faster then the alternatives, since files do not have to be opened. This is especially true of folder with many files or folder on slow (network) resources shall be tested.

CONTENT

public static final ContentExtensionFileFilter.TestStrategy CONTENT

Files will only be tested by their content.

This option allow to distinguish file types by the file content and does not require them to have unique extensions. Note that this option can be slow if many files are contained in a folder or a folder is located on a slow resource, since each file needs to be opened.

BOTH

public static final ContentExtensionFileFilter.TestStrategy BOTH

Files will first be selected by their extension and those will additionally be tested by their content.

This option is a compromise between the other two. It is faster than CONTENT since only files with a respective extension need to be opened and still allows to determine between file types, that may share an extension. It should always be preferred over CONTENT if files can be expected to have one of the defined extensions.

Method Detail

values

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

Returns:

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

valueOf

public static ContentExtensionFileFilter.TestStrategy valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null