to.etc.util

Class FileIterator

java.lang.Object

to.etc.util.FileIterator

All Implemented Interfaces:

Iterable<FileIterator.Entry>, Iterator<FileIterator.Entry>

@DefaultNonNull
public class FileIterator
extends Object
implements Iterator<FileIterator.Entry>, Iterable<FileIterator.Entry>

This iterator allows you to walk through all files/directories in a directory tree using just a loop instead of the usual set of recursive methods. The basic way to use it is:

     File path = new File("/path/to/dir");
     for(Entry entry: new FileIterator(path)) {
         //-- Use information from entry like File, type, and whether this is a "before" or "after" directory call.
     }
 

See main(String[]) for a runnable example of it's use.

The iterator traverses the entire directory tree starting (but excluding) with the path passed. It walks all files and all directories in the order that they are encountered. Files are reported once (meaning each file will return a single Entry), but directories will be reported twice: once before the files belonging inside the directory are traversed and once immediately after. This means a directory is always seen twice, and while traversing you can decide when to do something with that directory. For example when deleting a structure with this iterator you would delete files immediately but directories when the entry type is DirectoryAfter.

Author:

Frits Jalvingh Created on 4/12/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileIterator.Entry
static class	FileIterator.Type

Constructor Summary

Constructors

Constructor and Description
FileIterator(File root)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Iterator<FileIterator.Entry>	iterator()
static void	main(String[] args) Runnable example of usage.
FileIterator.Entry	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FileIterator

public FileIterator(File root)

Method Detail

remove

public void remove()

Specified by:

remove in interface Iterator<FileIterator.Entry>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<FileIterator.Entry>

next

public FileIterator.Entry next()

Specified by:

next in interface Iterator<FileIterator.Entry>

iterator

public Iterator<FileIterator.Entry> iterator()

Specified by:

iterator in interface Iterable<FileIterator.Entry>

main

public static void main(String[] args)
                 throws Exception

Runnable example of usage.

Parameters:

args -

Throws:

Exception