com.helger.commons.io.file.iterate

Class FileSystemIterator

java.lang.Object

com.helger.commons.collection.iterate.IterableIterator<File>

com.helger.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

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

Methods inherited from class com.helger.commons.collection.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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

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
                                                       IFileFilter aFileFilter)

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

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
                                                       IFileFilter aFileFilter)

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

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
                                                       IFileFilter... aFileFilters)

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.

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

Returns:

The matching iterator.

create

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

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.

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

Returns:

The matching iterator.