org.conqat.lib.commons.filesystem

Class AntPatternDirectoryScanner

java.lang.Object

org.conqat.lib.commons.filesystem.AntPatternDirectoryScanner

public class AntPatternDirectoryScanner
extends java.lang.Object

* This class performs directory scanning, i.e. returns all files residing within a certain directory. The list of files returned can be narrowed using include/exclude pattern, which use the same syntax as the pattern known from ANT (see http://ant.apache.org/manual/dirtasks.html#patterns).

This class is meant to be a faster and more memory efficient replacement for ANT's DirectoryScanner.

Internally this works entirely with '/' as path separator. However, this is not visible from the outside.

Internally, the implementation uses Java's RegEx engine by translating ANT patterns to regular expressions.

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	scan(java.lang.String baseDir, boolean caseSensitive, java.lang.String[] includePatterns, java.lang.String[] excludePatterns) Performs directory scanning.

Methods inherited from class java.lang.Object

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

Method Detail

scan

public static java.lang.String[] scan(java.lang.String baseDir,
                                      boolean caseSensitive,
                                      java.lang.String[] includePatterns,
                                      java.lang.String[] excludePatterns)
                               throws java.io.IOException

Performs directory scanning.

Parameters:

baseDir - the directory to start scanning in. All file names returned will be relative to this file.

caseSensitive - whether pattern should be applied case sensitive or not.

includePatterns - the include pattern (use ANT's pattern syntax)

excludePatterns - the exclude pattern (use ANT's pattern syntax)

Throws:

java.io.IOException - in case of invalid pattern provided.