|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.DirectoryScanner
org.apache.tools.ant.types.ArchiveScanner
public abstract class ArchiveScanner
ArchiveScanner accesses the pattern matching algorithm in DirectoryScanner, which are protected methods that can only be accessed by subclassing. This implementation of FileScanner defines getIncludedFiles to return the matching archive entries.
| Field Summary | |
|---|---|
protected java.io.File |
srcFile
The archive file which should be scanned. |
| Fields inherited from class org.apache.tools.ant.DirectoryScanner |
|---|
basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, selectors |
| Constructor Summary | |
|---|---|
ArchiveScanner()
|
|
| Method Summary | |
|---|---|
protected abstract void |
fillMapsFromArchive(Resource archive,
java.lang.String encoding,
java.util.Map fileEntries,
java.util.Map matchFileEntries,
java.util.Map dirEntries,
java.util.Map matchDirEntries)
Fills the file and directory maps with resources read from the archive. |
java.lang.String[] |
getIncludedDirectories()
Returns the names of the directories which matched at least one of the include patterns and none of the exclude patterns. |
int |
getIncludedDirsCount()
Override parent implementation. |
java.lang.String[] |
getIncludedFiles()
Returns the names of the files which matched at least one of the include patterns and none of the exclude patterns. |
int |
getIncludedFilesCount()
Override parent implementation. |
Resource |
getResource(java.lang.String name)
Get the named Resource. |
void |
init()
Initialize DirectoryScanner data structures. |
boolean |
match(java.lang.String path)
Matches a jar entry against the includes/excludes list, normalizing the path separator. |
void |
scan()
Don't scan when we have no zipfile. |
void |
setEncoding(java.lang.String encoding)
Sets encoding of file names. |
void |
setSrc(java.io.File srcFile)
Sets the srcFile for scanning. |
void |
setSrc(Resource src)
Sets the src for scanning. |
protected static java.lang.String |
trimSeparator(java.lang.String s)
Remove trailing slash if present. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected java.io.File srcFile
| Constructor Detail |
|---|
public ArchiveScanner()
| Method Detail |
|---|
public void scan()
scan in interface FileScannerscan in class DirectoryScannerpublic void setSrc(java.io.File srcFile)
srcFile - the (non-null) archive file name for scanningpublic void setSrc(Resource src)
src - the (non-null) archive resourcepublic void setEncoding(java.lang.String encoding)
encoding - the encoding formatpublic java.lang.String[] getIncludedFiles()
getIncludedFiles in interface FileScannergetIncludedFiles in class DirectoryScannerpublic int getIncludedFilesCount()
getIncludedFilesCount in class DirectoryScannerpublic java.lang.String[] getIncludedDirectories()
getIncludedDirectories in interface FileScannergetIncludedDirectories in class DirectoryScannerpublic int getIncludedDirsCount()
getIncludedDirsCount in class DirectoryScannerpublic void init()
public boolean match(java.lang.String path)
path - the (non-null) path name to test for inclusion
true if the path should be included
false otherwise.public Resource getResource(java.lang.String name)
getResource in interface ResourceFactorygetResource in class DirectoryScannername - path name of the file sought in the archive
protected abstract void fillMapsFromArchive(Resource archive,
java.lang.String encoding,
java.util.Map fileEntries,
java.util.Map matchFileEntries,
java.util.Map dirEntries,
java.util.Map matchDirEntries)
archive - the archive to scan.encoding - encoding used to encode file names inside the archive.fileEntries - Map (name to resource) of non-directory
resources found inside the archive.matchFileEntries - Map (name to resource) of non-directory
resources found inside the archive that matched all include
patterns and didn't match any exclude patterns.dirEntries - Map (name to resource) of directory
resources found inside the archive.matchDirEntries - Map (name to resource) of directory
resources found inside the archive that matched all include
patterns and didn't match any exclude patterns.protected static final java.lang.String trimSeparator(java.lang.String s)
s - the file name to trim.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||