org.apache.maven.shared.model.fileset.util

Class FileSetManager

public class FileSetManager extends Object

Provides operations for use with FileSet instances, such as retrieving the included/excluded files, deleting all matching entries, etc.

Author: jdcasey

Constructor Summary
FileSetManager(Log log, boolean verbose)
Create a new manager instance with the supplied log instance and flag for whether to output verbose messages.
FileSetManager(Log log)
Create a new manager instance with the supplied log instance.
FileSetManager()
Create a new manager instance with an empty log.
Method Summary
voiddelete(FileSet fileSet)
Delete the matching files and directories for the given file-set definition.
String[]getExcludedDirectories(FileSet fileSet)
Get all the directory names which have been excluded by the rules in this fileset.
String[]getExcludedFiles(FileSet fileSet)
Get all the filenames which have been excluded by the rules in this fileset.
String[]getIncludedDirectories(FileSet fileSet)
Get all the directory names which have been included by the rules in this fileset.
String[]getIncludedFiles(FileSet fileSet)
Get all the filenames which have been included by the rules in this fileset.

Constructor Detail

FileSetManager

public FileSetManager(Log log, boolean verbose)
Create a new manager instance with the supplied log instance and flag for whether to output verbose messages.

Parameters: log The mojo log instance verbose Whether to output verbose messages

FileSetManager

public FileSetManager(Log log)
Create a new manager instance with the supplied log instance. Verbose flag is set to false.

Parameters: log The mojo log instance

FileSetManager

public FileSetManager()
Create a new manager instance with an empty log. Verbose flag is set to false.

Parameters: log The mojo log instance

Method Detail

delete

public void delete(FileSet fileSet)
Delete the matching files and directories for the given file-set definition.

Parameters: fileSet The file-set matching rules, along with search base directory

Throws: IOException If a matching file cannot be deleted

getExcludedDirectories

public String[] getExcludedDirectories(FileSet fileSet)
Get all the directory names which have been excluded by the rules in this fileset.

Parameters: fileSet The fileset defining rules for inclusion/exclusion, and base directory.

Returns: the array of non-matching dirnames, relative to the basedir of the file-set.

getExcludedFiles

public String[] getExcludedFiles(FileSet fileSet)
Get all the filenames which have been excluded by the rules in this fileset.

Parameters: fileSet The fileset defining rules for inclusion/exclusion, and base directory.

Returns: the array of non-matching filenames, relative to the basedir of the file-set.

getIncludedDirectories

public String[] getIncludedDirectories(FileSet fileSet)
Get all the directory names which have been included by the rules in this fileset.

Parameters: fileSet The fileset defining rules for inclusion/exclusion, and base directory.

Returns: the array of matching dirnames, relative to the basedir of the file-set.

getIncludedFiles

public String[] getIncludedFiles(FileSet fileSet)
Get all the filenames which have been included by the rules in this fileset.

Parameters: fileSet The fileset defining rules for inclusion/exclusion, and base directory.

Returns: the array of matching filenames, relative to the basedir of the file-set.

Copyright © {inceptionYear}-2007 null. All Rights Reserved.