javatools.filehandlers

Class DeepFileSet

java.lang.Object

javatools.datatypes.PeekIterator<File>

javatools.filehandlers.DeepFileSet

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<File>, Iterator<File>

public class DeepFileSet
extends PeekIterator<File>

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 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 Iterator<File>	currentIterator
protected Stack<File>	paths
protected Pattern	wildcard

Fields inherited from class javatools.datatypes.PeekIterator

closed, EMPTY, fetchedNextValue, next

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected File	internalNext() Returns the next or NULL if no next element is available
static void	main(String[] argv) Test routine
Pattern	patternForWildcard(String wildcard)
protected boolean	setIterator() Pops a path, sets the iterator to the files in the path
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 Stack<File> paths

wildcard

protected final Pattern wildcard

currentIterator

protected Iterator<File> currentIterator

Constructor Detail

DeepFileSet

public DeepFileSet(File folderPlusWildcard)

Constructs a DeepFileSet from a path that ends in a wildcard

DeepFileSet

public DeepFileSet(String folderPlusWildcard)

Constructs a DeepFileSet from a path that ends in a wildcard

DeepFileSet

public DeepFileSet(File folder,
                   String wildcard)

Constructs a DeepFileSet from path and wildcard

Method Detail

patternForWildcard

public Pattern patternForWildcard(String wildcard)

setIterator

protected boolean setIterator()

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

internalNext

protected File internalNext()
                     throws Exception

Description copied from class: PeekIterator

Returns the next or NULL if no next element is available

Specified by:

internalNext in class PeekIterator<File>

Throws:

Exception

toString

public String toString()

Returns the current state of this DeepFileSet

Overrides:

toString in class PeekIterator<File>

main

public static void main(String[] argv)

Test routine