javatools.filehandlers

Class DeepFileSet

java.lang.Object

javatools.datatypes.PeekIterator<java.io.File>

javatools.filehandlers.DeepFileSet

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<java.io.File>, java.util.Iterator<java.io.File>

public class DeepFileSet
extends PeekIterator<java.io.File>

This class is part of the Java Tools (see http://mpii.de/yago-naga/javatools). It is licensed under the Creative Commons Attribution License (see http://creativecommons.org/licenses/by/3.0) by the YAGO-NAGA team (see http://mpii.de/yago-naga). This class represents a set of files as given by a wildcard string. It can also recurse into subfolders. It does not return folders and is not case-sensitive. The class can be used as an Iterator or Iterable (e.g. in a for-each-loop).
Example:

 for(File f : new DeepFileSet("c:\\myfiles","*.jaVa"))
 System.out.println(f);
 -->
 c:\myfiles\FileSet.java
 c:\myfiles\HTMLReader.java
 c:\myfiles\mysubfolder\OtherFile.java
 ...
 

Nested Class Summary

Nested classes/interfaces inherited from class javatools.datatypes.PeekIterator

PeekIterator.ElementaryPeekIterator<T>, PeekIterator.SimplePeekIterator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Iterator<java.io.File>	currentIterator
protected java.util.Stack<java.io.File>	paths
protected java.util.regex.Pattern	wildcard

Fields inherited from class javatools.datatypes.PeekIterator

closed, EMPTY, initialized, next

Constructor Summary

Constructors

Constructor and Description
DeepFileSet(java.io.File folderPlusWildcard) Constructs a DeepFileSet from a path that ends in a wildcard
DeepFileSet(java.io.File folder, java.lang.String wildcard) Constructs a DeepFileSet from path and wildcard
DeepFileSet(java.lang.String folderPlusWildcard) Constructs a DeepFileSet from a path that ends in a wildcard

Method Summary

Modifier and Type	Method and Description
protected java.io.File	internalNext() Returns the next or NULL if no next element is available
static void	main(java.lang.String[] argv) Test routine
java.util.regex.Pattern	patternForWildcard(java.lang.String wildcard)
protected boolean	setIterator() Pops a path, sets the iterator to the files in the path
java.lang.String	toString() Returns the current state of this DeepFileSet

Methods inherited from class javatools.datatypes.PeekIterator

asList, asList, asSet, asSet, asSet, close, emptyIterator, hasNext, internalSilentNext, iterator, list, list, next, nextOrNull, numElements, numElements, peek, remove, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

paths

protected final java.util.Stack<java.io.File> paths

wildcard

protected final java.util.regex.Pattern wildcard

currentIterator

protected java.util.Iterator<java.io.File> currentIterator

Constructor Detail

DeepFileSet

public DeepFileSet(java.io.File folderPlusWildcard)

Constructs a DeepFileSet from a path that ends in a wildcard

DeepFileSet

public DeepFileSet(java.lang.String folderPlusWildcard)

Constructs a DeepFileSet from a path that ends in a wildcard

DeepFileSet

public DeepFileSet(java.io.File folder,
                   java.lang.String wildcard)

Constructs a DeepFileSet from path and wildcard

Method Detail

patternForWildcard

public java.util.regex.Pattern patternForWildcard(java.lang.String wildcard)

setIterator

protected boolean setIterator()

Pops a path, sets the iterator to the files in the path

internalNext

protected java.io.File internalNext()
                             throws java.lang.Exception

Description copied from class: PeekIterator

Returns the next or NULL if no next element is available

Specified by:

internalNext in class PeekIterator<java.io.File>

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Returns the current state of this DeepFileSet

Overrides:

toString in class PeekIterator<java.io.File>

main

public static void main(java.lang.String[] argv)

Test routine