com.helger.commons.io.file

Class FileSystemIterator

java.lang.Object

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

com.helger.commons.io.file.FileSystemIterator

All Implemented Interfaces:

ICommonsIterable<File>, IIterableIterator<File>, Serializable, 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

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods inherited from class com.helger.commons.collection.iterate.IterableIterator

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 com.helger.commons.collection.iterate.IIterableIterator

withFilter, withMapper

Methods inherited from interface com.helger.commons.collection.impl.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstMapped, findFirstMapped, forEach, forEachBreakable, forEachByIndex, getCount, getCount

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.

FileSystemIterator

public FileSystemIterator(@Nonnull
                          File aBaseDir,
                          @Nonnull
                          String sDirName)

Constructor.

Parameters:

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

sDirName - The directory name relative to the passed base directory. May not be null.