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

java.lang.Object
  extended by org.apache.maven.shared.model.fileset.util.FileSetManager

public class FileSetManager
extends java.lang.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()
          Create a new manager instance with an empty log.
FileSetManager(org.apache.maven.plugin.logging.Log log)
          Create a new manager instance with the supplied log instance.
FileSetManager(org.apache.maven.plugin.logging.Log log, boolean verbose)
          Create a new manager instance with the supplied log instance and flag for whether to output verbose messages.
 
Method Summary
 void delete(FileSet fileSet)
          Delete the matching files and directories for the given file-set definition.
 java.lang.String[] getExcludedDirectories(FileSet fileSet)
          Get all the directory names which have been excluded by the rules in this fileset.
 java.lang.String[] getExcludedFiles(FileSet fileSet)
          Get all the filenames which have been excluded by the rules in this fileset.
 java.lang.String[] getIncludedDirectories(FileSet fileSet)
          Get all the directory names which have been included by the rules in this fileset.
 java.lang.String[] getIncludedFiles(FileSet fileSet)
          Get all the filenames which have been included by the rules in this fileset.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileSetManager

public FileSetManager(org.apache.maven.plugin.logging.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(org.apache.maven.plugin.logging.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

getIncludedFiles

public java.lang.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.

getIncludedDirectories

public java.lang.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.

getExcludedFiles

public java.lang.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.

getExcludedDirectories

public java.lang.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.

delete

public void delete(FileSet fileSet)
            throws java.io.IOException
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:
java.io.IOException - If a matching file cannot be deleted


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