Class FileSetManager
- java.lang.Object
-
- 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
Constructors Constructor Description FileSetManager()
Create a new manager instance with an own logger.FileSetManager(org.slf4j.Logger logger)
Create a new manager instance with the supplied log instance.FileSetManager(org.slf4j.Logger logger, boolean verbose)
Create a new manager instance with the supplied log instance and flag for whether to output verbose messages.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
delete(FileSet fileSet)
Delete the matching files and directories for the given file-set definition.void
delete(FileSet fileSet, boolean throwsError)
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.java.util.Map<java.lang.String,java.lang.String>
mapIncludedFiles(FileSet fileSet)
-
-
-
Constructor Detail
-
FileSetManager
public FileSetManager(org.slf4j.Logger logger, boolean verbose)
Create a new manager instance with the supplied log instance and flag for whether to output verbose messages.- Parameters:
logger
- the logger instanceverbose
- whether to output verbose messages
-
FileSetManager
public FileSetManager(org.slf4j.Logger logger)
Create a new manager instance with the supplied log instance. Verbose flag is set to false.- Parameters:
logger
- The log instance
-
FileSetManager
public FileSetManager()
Create a new manager instance with an own logger. Verbose flag is set to false.
-
-
Method Detail
-
mapIncludedFiles
public java.util.Map<java.lang.String,java.lang.String> mapIncludedFiles(FileSet fileSet) throws MapperException
- Parameters:
fileSet
-FileSet
- Returns:
- the included files as map
- Throws:
MapperException
- if any- See Also:
getIncludedFiles(FileSet)
-
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
-
delete
public void delete(FileSet fileSet, boolean throwsError) 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 directorythrowsError
- throw IOException when errors have occurred by deleting files or directories- Throws:
java.io.IOException
- if a matching file cannot be deleted andthrowsError=true
, otherwise print warning messages
-
-