com.cloudhopper.commons.util.filefilter

Class FileExtensionFilter

java.lang.Object

com.cloudhopper.commons.util.filefilter.FileExtensionFilter

All Implemented Interfaces:

FileFilter

public class FileExtensionFilter
extends Object
implements FileFilter

Accepts a file based on its file extension against a list of one or more acceptable file extensions.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
FileExtensionFilter(String extension) Creates a new instance of a FileExtensionMatcher that will perform a case insensitive match to this file extension.
FileExtensionFilter(String[] extensions) Creates a new instance of a FileExtensionMatcher that will perform a case insensitive match to this array of file extensions.
FileExtensionFilter(String[] extensions, boolean caseSensitive) Creates a new instance of a FileExtensionMatcher that will perform a match to this array of file extensions.
FileExtensionFilter(String extension, boolean caseSensitive) Creates a new instance of a FileExtensionMatcher that will perform a match to this file extension.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(File file) Accepts a File by its file extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileExtensionFilter

public FileExtensionFilter(String extension)
                    throws IllegalArgumentException

Creates a new instance of a FileExtensionMatcher that will perform a case insensitive match to this file extension.

Parameters:

extension - The file extension to match against a File

Throws:

IllegalArgumentException - Thrown if the file extension is not formatted correctly such as containing a period.

FileExtensionFilter

public FileExtensionFilter(String[] extensions)
                    throws IllegalArgumentException

Creates a new instance of a FileExtensionMatcher that will perform a case insensitive match to this array of file extensions.

Parameters:

extension - The array of file extensions to match against a File

Throws:

IllegalArgumentException - Thrown if the file extension is not formatted correctly such as containing a period.

FileExtensionFilter

public FileExtensionFilter(String extension,
                   boolean caseSensitive)
                    throws IllegalArgumentException

Creates a new instance of a FileExtensionMatcher that will perform a match to this file extension.

Parameters:

extension - The file extension to match against a File

caseSensitive - If true the extension must match the case of the provided extension, otherwise a case insensitive match will occur.

Throws:

IllegalArgumentException - Thrown if the file extension is not formatted correctly such as containing a period.

FileExtensionFilter

public FileExtensionFilter(String[] extensions,
                   boolean caseSensitive)
                    throws IllegalArgumentException

Creates a new instance of a FileExtensionMatcher that will perform a match to this array of file extensions.

Parameters:

extension - The array of file extensions to match against a File

caseSensitive - If true the extension must match the case of the provided extension, otherwise a case insensitive match will occur.

Throws:

IllegalArgumentException - Thrown if the file extension is not formatted correctly such as containing a period.

Method Detail

accept

public boolean accept(File file)

Accepts a File by its file extension.

Specified by:

accept in interface FileFilter

Parameters:

file - The file to match

Returns:

True if the File matches this the array of acceptable file extensions.