org.apache.tools.ant.types

Class ZipScanner

public class ZipScanner extends DirectoryScanner

ZipScanner 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 Zip entries.
Field Summary
protected FilesrcFile
The zip file which should be scanned.
Method Summary
String[]getIncludedDirectories()
Returns the names of the directories which matched at least one of the include patterns and none of the exclude patterns.
String[]getIncludedFiles()
Returns the names of the files which matched at least one of the include patterns and none of the exclude patterns.
ResourcegetResource(String name)
voidinit()
Initialize DirectoryScanner data structures.
booleanmatch(String path)
Matches a jar entry against the includes/excludes list, normalizing the path separator.
voidsetEncoding(String encoding)
Sets encoding of file names.
voidsetSrc(File srcFile)
Sets the srcFile for scanning.

Field Detail

srcFile

protected File srcFile
The zip file which should be scanned.

Method Detail

getIncludedDirectories

public String[] getIncludedDirectories()
Returns the names of the directories which matched at least one of the include patterns and none of the exclude patterns. The names are relative to the base directory.

Returns: the names of the directories which matched at least one of the include patterns and none of the exclude patterns.

getIncludedFiles

public String[] getIncludedFiles()
Returns the names of the files which matched at least one of the include patterns and none of the exclude patterns. The names are relative to the base directory.

Returns: the names of the files which matched at least one of the include patterns and none of the exclude patterns.

getResource

public Resource getResource(String name)

Parameters: name path name of the file sought in the archive

Since: Ant 1.5.2

init

public void init()
Initialize DirectoryScanner data structures.

match

public boolean match(String path)
Matches a jar entry against the includes/excludes list, normalizing the path separator.

Parameters: path the (non-null) path name to test for inclusion

Returns: true if the path should be included false otherwise.

setEncoding

public void setEncoding(String encoding)
Sets encoding of file names.

Since: Ant 1.6

setSrc

public void setSrc(File srcFile)
Sets the srcFile for scanning. This is the jar or zip file that is scanned for matching entries.

Parameters: srcFile the (non-null) zip file name for scanning

Copyright