bradleyross.library.helpers

Class DirWalker.DirIterator

java.lang.Object

bradleyross.library.helpers.DirWalker.DirIterator

All Implemented Interfaces:

Iterator<File>

Enclosing class:

DirWalker

protected class DirWalker.DirIterator
extends Object
implements Iterator<File>

This iterates through the directories.

The current location in the tree is given by the structures levels and depth.

Author:

Bradley Ross

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count Number of directories that have been retrieved using next.
protected File	currentDir
protected DirWalker.Level	currentLevel
protected int	depth Depth of the search tree.
protected boolean	done Set to true after the last directory has been retrieved using the next method.
protected boolean	initial Set to false after first directory has been retrieved using the next method.
protected ArrayList<DirWalker.Level>	levels Array of Level objects representing the levels in the tree search.
protected int	limit
protected File	nextDir
protected File	root

Constructor Summary

Constructors

Constructor and Description
DirIterator(File value) Constructor using depth first search.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Determines if there are more items in the list.
File	next() Returns the next item in the list.
void	remove() This method is an optional method that is not implemented for this class.

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

Field Detail

root

protected File root

depth

protected int depth

Depth of the search tree.

A value of zero means that there are no levels. A value of n means that there are n levels and the highest level is n-1.

levels

protected ArrayList<DirWalker.Level> levels

Array of Level objects representing the levels in the tree search.

The current positions in the levels at the start of executing next represent the next item to be retrieved.

done

protected boolean done

Set to true after the last directory has been retrieved using the next method.

initial

protected boolean initial

Set to false after first directory has been retrieved using the next method.

currentLevel

protected DirWalker.Level currentLevel

currentDir

protected File currentDir

nextDir

protected File nextDir

limit

protected int limit

count

protected int count

Number of directories that have been retrieved using next.

Constructor Detail

DirIterator

public DirIterator(File value)
            throws IOException

Constructor using depth first search.

Parameters:

value - root directory

Throws:

IOException - if io problems

Method Detail

next

public File next()
          throws NoSuchElementException

Returns the next item in the list.

Specified by:

next in interface Iterator<File>

Returns:

next item

Throws:

NoSuchElementException

hasNext

public boolean hasNext()

Determines if there are more items in the list.

Specified by:

hasNext in interface Iterator<File>

Returns:

true if there are more items

remove

public void remove()

This method is an optional method that is not implemented for this class.

Specified by:

remove in interface Iterator<File>