com.revolsys.io.filter

Class NameFilenameFilter

java.lang.Object

com.revolsys.io.filter.NameFilenameFilter

All Implemented Interfaces:

FilenameFilter

public class NameFilenameFilter
extends Object
implements FilenameFilter

The NameFilenameFilter is a FilenameFilter that only returns files if the have one of the specified file names. More than one file name can be specified by using the addName(String) method.

Author:

Paul Austin

Constructor Summary

Constructors

Constructor and Description
NameFilenameFilter() Construct a new NameFilenameFilter with no file names.
NameFilenameFilter(Collection filenames) Construct a new NameFilenameFilter with the file names.
NameFilenameFilter(Collection filenames, boolean readOnly) Construct a new NameFilenameFilter with the single file name.
NameFilenameFilter(String filename) Construct a new NameFilenameFilter with the single file name.
NameFilenameFilter(String filename, boolean readOnly) Construct a new NameFilenameFilter with the single file name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(File directory, String filename) Check to see if the file should be included in the list of matched files
void	addName(String name) Add the file name to the names to find.
void	addNames(Collection names) Add the file names to the names to find.
protected boolean	isReadOnly() Get the flag indicating if the filter can be modified.
protected void	setReadOnly(boolean readOnly) Set the flag indicating if the filter can be modified.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameFilenameFilter

public NameFilenameFilter()

Construct a new NameFilenameFilter with no file names.

NameFilenameFilter

public NameFilenameFilter(Collection filenames)

Construct a new NameFilenameFilter with the file names.

Parameters:

filenames - The file names.

NameFilenameFilter

public NameFilenameFilter(Collection filenames,
                  boolean readOnly)

Construct a new NameFilenameFilter with the single file name.

Parameters:

filenames - The file names.

readOnly - Flag indicating if the filter can be modified.

NameFilenameFilter

public NameFilenameFilter(String filename)

Construct a new NameFilenameFilter with the single file name.

Parameters:

filename - The file name.

NameFilenameFilter

public NameFilenameFilter(String filename,
                  boolean readOnly)

Construct a new NameFilenameFilter with the single file name.

Parameters:

filename - The file name.

readOnly - Flag indicating if the filter can be modified.

Method Detail

accept

public boolean accept(File directory,
             String filename)

Check to see if the file should be included in the list of matched files

Specified by:

accept in interface FilenameFilter

Parameters:

directory - The directory in which the file was found.

filename - The name of the file.

Returns:

True if the file matched, false otherwise.

addName

public void addName(String name)

Add the file name to the names to find.

Parameters:

name - The file name.

addNames

public void addNames(Collection names)

Add the file names to the names to find.

Parameters:

names - The file names.

isReadOnly

protected final boolean isReadOnly()

Get the flag indicating if the filter can be modified.

Returns:

The flag indicating if the filter can be modified.

setReadOnly

protected final void setReadOnly(boolean readOnly)

Set the flag indicating if the filter can be modified. If the flag is read only it cannot be changed to writable.

Parameters:

readOnly - The flag indicating if the filter can be modified.