top.marchand.xml.maven.plugin.xsl.scandir

Class DirectoryScanner

java.lang.Object

top.marchand.xml.maven.plugin.xsl.scandir.DirectoryScanner

public class DirectoryScanner
extends Object

A class to scan a directory and find files that match a FileSet

Since:

1.0.0

Author:

cmarchand

Constructor Summary

Constructors

Constructor and Description
DirectoryScanner(File baseDir, org.apache.maven.plugin.logging.Log log) Constructs a DirectoryScanner on baseDir, with default includes and default excludes.
DirectoryScanner(FileSet fileset, File projectBaseDir, org.apache.maven.plugin.logging.Log log) Constructs a DirectoryScanner for the specified FileSet

Method Summary

Modifier and Type	Method and Description
File	getBaseDir() Return the directory where scan happens in
List<String>	getDefaultExcludes() Returns default excludes to use.
List<String>	getDefaultIncludes() Returns default includes to use Present to be overwritten.
protected void	prepareFilters() Initialize working attributes.
List<Path>	scan() Returns a list of pathes relative to fileset's basedir
protected List<Path>	scan(File dir)
void	setScanListener(ScanListener listener) Sets the ScanListener to use

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryScanner

public DirectoryScanner(File baseDir,
                        org.apache.maven.plugin.logging.Log log)

Constructs a DirectoryScanner on baseDir, with default includes and default excludes.

Parameters:

baseDir - The directory to scan

log - The maven logger to use

See Also:

FileSet.getDefaultIncludes(), FileSet.getDefaultExcludes()

DirectoryScanner

public DirectoryScanner(FileSet fileset,
                        File projectBaseDir,
                        org.apache.maven.plugin.logging.Log log)

Constructs a DirectoryScanner for the specified FileSet

Parameters:

fileset - The descriptoin of which files to get

projectBaseDir. - The project base dir, to relocate baseDir if baseDir does not exists

log - The maven logger to use

Method Detail

getDefaultIncludes

public List<String> getDefaultIncludes()

Returns default includes to use Present to be overwritten.

Returns:

The default includes

getDefaultExcludes

public List<String> getDefaultExcludes()

Returns default excludes to use. Present to be overwritten.

Returns:

The default excludes

scan

public List<Path> scan()

Returns a list of pathes relative to fileset's basedir

Returns:

Found pathes

prepareFilters

protected void prepareFilters()

Initialize working attributes.

scan

protected List<Path> scan(File dir)

getBaseDir

public File getBaseDir()

Return the directory where scan happens in

Returns:

The base directory of scan

setScanListener

public void setScanListener(ScanListener listener)

Sets the ScanListener to use

Parameters:

listener - The listener to be notified