Package org.apache.maven.scm
Class ScmFileSet
- java.lang.Object
-
- org.apache.maven.scm.ScmFileSet
-
- All Implemented Interfaces:
java.io.Serializable
public class ScmFileSet extends java.lang.Object implements java.io.Serializable
Set of files used for SCM operations. Consists of the base directory of the files and a list of files relative to that directory.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.io.File
basedir
private static java.lang.String
DEFAULT_EXCLUDES
private static java.lang.String
DELIMITER
private java.lang.String
excludes
private java.util.List<java.io.File>
files
List of File objects, all relative to the basedir.private java.lang.String
includes
private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description ScmFileSet(java.io.File basedir)
Create a file set with no files, only the base directory.ScmFileSet(java.io.File basedir, java.io.File file)
Create a file set with only the file provided, relative to basedir.ScmFileSet(java.io.File basedir, java.io.File[] files)
Deprecated.use ScmFileSet( File, List )ScmFileSet(java.io.File basedir, java.lang.String includes)
Create a file set with files from basefile, using includes provided and default excludes.ScmFileSet(java.io.File basedir, java.lang.String includes, java.lang.String excludes)
Create a file set with only files (not directories) from basefile, using includes and excludes provided.ScmFileSet(java.io.File basedir, java.util.List<java.io.File> files)
Create a file set with the files provided, relative to basedir.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.io.File
getBasedir()
Get the base directory of the file set.java.lang.String
getExcludes()
java.util.List<java.io.File>
getFileList()
Get the list of files in the set, relative to basedirjava.io.File[]
getFiles()
Deprecated.use getFileList() insteadjava.lang.String
getIncludes()
java.lang.String
toString()
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
DELIMITER
private static final java.lang.String DELIMITER
- See Also:
- Constant Field Values
-
DEFAULT_EXCLUDES
private static final java.lang.String DEFAULT_EXCLUDES
- See Also:
AbstractScanner.DEFAULTEXCLUDES
-
basedir
private final java.io.File basedir
-
includes
private java.lang.String includes
-
excludes
private java.lang.String excludes
-
files
private final java.util.List<java.io.File> files
List of File objects, all relative to the basedir.
-
-
Constructor Detail
-
ScmFileSet
public ScmFileSet(java.io.File basedir)
Create a file set with no files, only the base directory.- Parameters:
basedir
- directory files in the set are relative to
-
ScmFileSet
public ScmFileSet(java.io.File basedir, java.io.File file)
Create a file set with only the file provided, relative to basedir.- Parameters:
basedir
- directory file is relative tofile
- file that the set will contain, has to be relative to basedir
-
ScmFileSet
public ScmFileSet(java.io.File basedir, java.lang.String includes, java.lang.String excludes) throws java.io.IOException
Create a file set with only files (not directories) from basefile, using includes and excludes provided.- Parameters:
basedir
- directory files are relative toincludes
- Ant pattern for files to includeexcludes
- Ant pattern for files to exclude, if null DEFAULT_EXCLUDES is used, else DEFAULT_EXCLUDES is added.- Throws:
java.io.IOException
- if any
-
ScmFileSet
public ScmFileSet(java.io.File basedir, java.lang.String includes) throws java.io.IOException
Create a file set with files from basefile, using includes provided and default excludes.- Parameters:
basedir
- directory files are relative toincludes
- Ant pattern for files to include- Throws:
java.io.IOException
- if any- Since:
- 1.0
-
ScmFileSet
public ScmFileSet(java.io.File basedir, java.io.File[] files)
Deprecated.use ScmFileSet( File, List )Create a file set with the files provided, relative to basedir.- Parameters:
basedir
- directory files are relative tofiles
- files that the set will contain, have to be relative to basedir
-
ScmFileSet
public ScmFileSet(java.io.File basedir, java.util.List<java.io.File> files)
Create a file set with the files provided, relative to basedir.- Parameters:
basedir
- directory files are relative tofiles
- list of File objects, files that the set will contain, have to be relative to basedir
-
-
Method Detail
-
getBasedir
public java.io.File getBasedir()
Get the base directory of the file set. It's the directory files in the set are relative to.- Returns:
- base directory
-
getFiles
public java.io.File[] getFiles()
Deprecated.use getFileList() insteadGet the list of files in the set, relative to basedir- Returns:
- files in this set
-
getFileList
public java.util.List<java.io.File> getFileList()
Get the list of files in the set, relative to basedir- Returns:
- List of File objects
-
getIncludes
public java.lang.String getIncludes()
- Returns:
- the includes files as a comma separated string
-
getExcludes
public java.lang.String getExcludes()
- Returns:
- the excludes files as a comma separated string
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-