Package org.codehaus.plexus.util

Class DirectoryWalker

java.lang.Object

org.codehaus.plexus.util.DirectoryWalker

public class DirectoryWalker
extends java.lang.Object

DirectoryWalker

Version:

$Id$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	DirectoryWalker.DirStackEntry	DirStackEntry is an Item on the dirStack

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.File	baseDir
private int	baseDirOffset
private boolean	debugEnabled
private java.util.Stack<DirectoryWalker.DirStackEntry>	dirStack
private java.util.List<java.lang.String>	excludes
private java.util.List<java.lang.String>	includes
private boolean	isCaseSensitive
private java.util.List<DirectoryWalkListener>	listeners

Constructor Summary

Constructors

Constructor	Description
DirectoryWalker()

Method Summary

Modifier and Type	Method	Description
void	addDirectoryWalkListener(DirectoryWalkListener listener)
void	addExclude(java.lang.String exclude)
void	addInclude(java.lang.String include)
void	addSCMExcludes()	Add's to the Exclude List the default list of SCM excludes.
private void	fireDebugMessage(java.lang.String message)
private void	fireStep(java.io.File file)
private void	fireWalkFinished()
private void	fireWalkStarting()
private java.lang.String	fixPattern(java.lang.String pattern)
java.io.File	getBaseDir()
java.util.List<java.lang.String>	getExcludes()
java.util.List<java.lang.String>	getIncludes()
private boolean	isExcluded(java.lang.String name)
private boolean	isIncluded(java.lang.String name)
private boolean	isMatch(java.util.List<java.lang.String> patterns, java.lang.String name)
private java.lang.String	relativeToBaseDir(java.io.File file)
void	removeDirectoryWalkListener(DirectoryWalkListener listener)	Removes a DirectoryWalkListener.
void	scan()	Performs a Scan against the provided setBaseDir(File)
private void	scanDir(java.io.File dir)
void	setBaseDir(java.io.File baseDir)
void	setDebugMode(boolean debugEnabled)
void	setExcludes(java.util.List<java.lang.String> entries)
void	setIncludes(java.util.List<java.lang.String> entries)

Methods inherited from class java.lang.Object

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

Field Detail

baseDir

private java.io.File baseDir

baseDirOffset

private int baseDirOffset

dirStack

private java.util.Stack<DirectoryWalker.DirStackEntry> dirStack

excludes

private java.util.List<java.lang.String> excludes

includes

private java.util.List<java.lang.String> includes

isCaseSensitive

private boolean isCaseSensitive

listeners

private java.util.List<DirectoryWalkListener> listeners

debugEnabled

private boolean debugEnabled

Constructor Detail

DirectoryWalker

public DirectoryWalker()

Method Detail

addDirectoryWalkListener

public void addDirectoryWalkListener(DirectoryWalkListener listener)

addExclude

public void addExclude(java.lang.String exclude)

addInclude

public void addInclude(java.lang.String include)

addSCMExcludes

public void addSCMExcludes()

Add's to the Exclude List the default list of SCM excludes.

fireStep

private void fireStep(java.io.File file)

fireWalkFinished

private void fireWalkFinished()

fireWalkStarting

private void fireWalkStarting()

fireDebugMessage

private void fireDebugMessage(java.lang.String message)

fixPattern

private java.lang.String fixPattern(java.lang.String pattern)

setDebugMode

public void setDebugMode(boolean debugEnabled)

getBaseDir

public java.io.File getBaseDir()

Returns:

Returns the baseDir.

getExcludes

public java.util.List<java.lang.String> getExcludes()

Returns:

Returns the excludes.

getIncludes

public java.util.List<java.lang.String> getIncludes()

Returns:

Returns the includes.

isExcluded

private boolean isExcluded(java.lang.String name)

isIncluded

private boolean isIncluded(java.lang.String name)

isMatch

private boolean isMatch(java.util.List<java.lang.String> patterns,
                        java.lang.String name)

relativeToBaseDir

private java.lang.String relativeToBaseDir(java.io.File file)

removeDirectoryWalkListener

public void removeDirectoryWalkListener(DirectoryWalkListener listener)

Removes a DirectoryWalkListener.

Parameters:

listener - the listener to remove.

scan

public void scan()

Performs a Scan against the provided setBaseDir(File)

scanDir

private void scanDir(java.io.File dir)

setBaseDir

public void setBaseDir(java.io.File baseDir)

Parameters:

baseDir - The baseDir to set.

setExcludes

public void setExcludes(java.util.List<java.lang.String> entries)

Parameters:

entries - The excludes to set.

setIncludes

public void setIncludes(java.util.List<java.lang.String> entries)

Parameters:

entries - The includes to set.