org.apache.tools.ant.types
public abstract class ArchiveScanner extends DirectoryScanner
Since: Ant 1.7
Field Summary | |
---|---|
protected File | srcFile
The archive file which should be scanned. |
Method Summary | |
---|---|
protected abstract void | fillMapsFromArchive(Resource archive, String encoding, Map fileEntries, Map matchFileEntries, Map dirEntries, Map matchDirEntries)
Fills the file and directory maps with resources read from the archive.
|
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. |
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(String name)
Get the named Resource. |
void | init()
Initialize DirectoryScanner data structures. |
boolean | match(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(String encoding)
Sets encoding of file names. |
void | setErrorOnMissingArchive(boolean errorOnMissingArchive)
Sets whether an error is thrown if an archive does not exist.
|
void | setSrc(File srcFile)
Sets the srcFile for scanning. |
void | setSrc(Resource src)
Sets the src for scanning. |
protected static String | trimSeparator(String s)
Remove trailing slash if present. |
Parameters: 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.
Returns: the names of the directories which matched at least one of the include patterns and none of the exclude patterns.
Returns: count of included directories.
Since: Ant 1.7
Returns: the names of the files which matched at least one of the include patterns and none of the exclude patterns.
Returns: count of included files.
Since: Ant 1.7
Parameters: name path name of the file sought in the archive
Returns: the resource
Since: Ant 1.5.2
Parameters: path the (non-null) path name to test for inclusion
Returns: true
if the path should be included
false
otherwise.
Since: Ant 1.7
Parameters: encoding the encoding format
Since: Ant 1.6
Parameters: errorOnMissingArchive true if missing archives cause errors, false if not.
Since: Ant 1.8.0
Parameters: srcFile the (non-null) archive file name for scanning
Parameters: src the (non-null) archive resource
Parameters: s the file name to trim.
Returns: the trimed file name.