com.phloc.commons.io.file.iterate

Class FileSystemIterator

java.lang.Object

com.phloc.commons.collections.iterate.IterableIterator<File>

com.phloc.commons.io.file.iterate.FileSystemIterator

All Implemented Interfaces:

IIterableIterator<File>, Iterable<File>, Iterator<File>

@NotThreadSafe
public final class FileSystemIterator
extends IterableIterator<File>

Iterate over the content of a single directory. Iteration is not recursive.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FileSystemIterator(File aBaseDir) Constructor.
FileSystemIterator(String sBaseDir) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static IIterableIterator<File>	create(File fBaseDir, FileFilter... aFileFilters) Create a new non-recursive file system iterator that uses multiple FileFilter objects that all need to match.
static IIterableIterator<File>	create(File fBaseDir, FileFilter aFileFilter) Create a new non-recursive file system iterator that uses a certain FileFilter.
static IIterableIterator<File>	create(File fBaseDir, FilenameFilter... aFilenameFilters) Create a new non-recursive file system iterator that uses multiple FilenameFilter objects that all need to match.
static IIterableIterator<File>	create(File fBaseDir, FilenameFilter aFilenameFilter) Create a new non-recursive file system iterator that uses a certain FilenameFilter.
static IIterableIterator<File>	create(String sBaseDir, FileFilter... aFileFilters) Create a new non-recursive file system iterator that uses multiple FileFilter objects that all need to match.
static IIterableIterator<File>	create(String sBaseDir, FileFilter aFileFilter) Create a new non-recursive file system iterator that uses a certain FileFilter.
static IIterableIterator<File>	create(String sBaseDir, FilenameFilter... aFilenameFilters) Create a new non-recursive file system iterator that uses multiple FilenameFilter objects that all need to match.
static IIterableIterator<File>	create(String sBaseDir, FilenameFilter aFilenameFilter) Create a new non-recursive file system iterator that uses a certain FilenameFilter.

Methods inherited from class com.phloc.commons.collections.iterate.IterableIterator

create, create, create, createEmpty, hasNext, iterator, next, remove, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemIterator

public FileSystemIterator(@Nonnull
                  String sBaseDir)

Constructor.

Parameters:

sBaseDir - The base directory to iterate. May not be null.

FileSystemIterator

public FileSystemIterator(@Nonnull
                  File aBaseDir)

Constructor.

Parameters:

aBaseDir - The base directory to iterate. May not be null.

Method Detail

create

@Nonnull
public static IIterableIterator<File> create(@Nonnull
                                     String sBaseDir,
                                     @Nonnull
                                     FilenameFilter aFilenameFilter)

Create a new non-recursive file system iterator that uses a certain FilenameFilter.

Parameters:

sBaseDir - The directory to iterate. May not be null.

aFilenameFilter - The filter to use. May not be null.

Returns:

The matching iterator.

create

@Nonnull
public static IIterableIterator<File> create(@Nonnull
                                     File fBaseDir,
                                     @Nonnull
                                     FilenameFilter aFilenameFilter)

Create a new non-recursive file system iterator that uses a certain FilenameFilter.

Parameters:

fBaseDir - The directory to iterate. May not be null.

aFilenameFilter - The filter to use. May not be null.

Returns:

The matching iterator.

create

@Nonnull
public static IIterableIterator<File> create(@Nonnull
                                     String sBaseDir,
                                     @Nonnull
                                     FilenameFilter... aFilenameFilters)

Create a new non-recursive file system iterator that uses multiple FilenameFilter objects that all need to match.

Parameters:

sBaseDir - The directory to iterate. May not be null.

aFilenameFilters - The filters to use. May not be null.

Returns:

The matching iterator.

create

@Nonnull
public static IIterableIterator<File> create(@Nonnull
                                     File fBaseDir,
                                     @Nonnull
                                     FilenameFilter... aFilenameFilters)

Create a new non-recursive file system iterator that uses multiple FilenameFilter objects that all need to match.

Parameters:

fBaseDir - The directory to iterate. May not be null.

aFilenameFilters - The filters to use. May not be null.

Returns:

The matching iterator.

create

@Nonnull
public static IIterableIterator<File> create(@Nonnull
                                     String sBaseDir,
                                     @Nonnull
                                     FileFilter aFileFilter)

Create a new non-recursive file system iterator that uses a certain FileFilter.

Parameters:

sBaseDir - The directory to iterate. May not be null.

aFileFilter - The filter to use. May not be null.

Returns:

The matching iterator.

create

@Nonnull
public static IIterableIterator<File> create(@Nonnull
                                     File fBaseDir,
                                     @Nonnull
                                     FileFilter aFileFilter)

Create a new non-recursive file system iterator that uses a certain FileFilter.

Parameters:

fBaseDir - The directory to iterate. May not be null.

aFileFilter - The filter to use. May not be null.

Returns:

The matching iterator.

create

@Nonnull
public static IIterableIterator<File> create(@Nonnull
                                     String sBaseDir,
                                     @Nonnull
                                     FileFilter... aFileFilters)

Create a new non-recursive file system iterator that uses multiple FileFilter objects that all need to match.

Parameters:

sBaseDir - The directory to iterate. May not be null.

aFileFilters - The filters to use. May not be null.

Returns:

The matching iterator.

create

@Nonnull
public static IIterableIterator<File> create(@Nonnull
                                     File fBaseDir,
                                     @Nonnull
                                     FileFilter... aFileFilters)

Create a new non-recursive file system iterator that uses multiple FileFilter objects that all need to match.

Parameters:

fBaseDir - The directory to iterate. May not be null.

aFileFilters - The filters to use. May not be null.

Returns:

The matching iterator.