org.codehaus.mojo.vfs.internal

Interface VfsDirectoryScanner

All Known Implementing Classes:

DefaultVfsDirectoryScanner

public interface VfsDirectoryScanner

Method Summary

Methods

Modifier and Type	Method and Description
List<org.apache.commons.vfs2.FileObject>	scan() Start the scan
void	setCaseSensitive(boolean isCaseSensitive)
void	setExcludes(String[] excludes) Sets the list of exclude patterns to use.
void	setIncludes(String[] includes) Sets the list of include patterns to use.
void	setStartingDirectory(org.apache.commons.vfs2.FileObject directory)

Method Detail

setStartingDirectory

void setStartingDirectory(org.apache.commons.vfs2.FileObject directory)

setIncludes

void setIncludes(String[] includes)

Sets the list of include patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar.

When a pattern ends with a '/' or '\', "**" is appended.

Parameters:

includes - A list of include patterns. May be null, indicating that all files should be included. If a non-null list is given, all elements must be non-null.

setExcludes

void setExcludes(String[] excludes)

Sets the list of exclude patterns to use. All '\' characters are replaced by '/'

When a pattern ends with a '/' or '\', "**" is appended.

Parameters:

excludes - A list of exclude patterns. May be null, indicating that no files should be excluded. If a non-null list is given, all elements must be non-null.

setCaseSensitive

void setCaseSensitive(boolean isCaseSensitive)

Parameters:

isCaseSensitive -

scan

List<org.apache.commons.vfs2.FileObject> scan()
                                              throws org.apache.commons.vfs2.FileSystemException

Start the scan

Returns:

Throws:

org.apache.commons.vfs2.FileSystemException