org.apache.tools.ant.types

Class ZipScanner

Implemented Interfaces:
FileScanner, ResourceFactory, SelectorScanner

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 File
srcFile
The zip file which should be scanned.

Fields inherited from class org.apache.tools.ant.DirectoryScanner

DEFAULTEXCLUDES, basedir, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, selectors

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.
Resource
getResource(String name)
void
init()
Initialize DirectoryScanner data structures.
boolean
match(String path)
Matches a jar entry against the includes/excludes list, normalizing the path separator.
void
setEncoding(String encoding)
Sets encoding of file names.
void
setSrc(File srcFile)
Sets the srcFile for scanning.

Methods inherited from class org.apache.tools.ant.DirectoryScanner

addDefaultExclude, addDefaultExcludes, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getIncludedDirectories, getIncludedDirsCount, getIncludedFiles, getIncludedFilesCount, getNotIncludedDirectories, getNotIncludedFiles, getResource, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scan, scandir, setBasedir, setBasedir, setCaseSensitive, setExcludes, setFollowSymlinks, setIncludes, setSelectors, slowScan

Field Details

srcFile

protected File srcFile
The zip file which should be scanned.

Method Details

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.
Specified by:
getIncludedDirectories in interface FileScanner
Overrides:
getIncludedDirectories in interface DirectoryScanner
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.
Specified by:
getIncludedFiles in interface FileScanner
Overrides:
getIncludedFiles in interface DirectoryScanner
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)
Specified by:
getResource in interface ResourceFactory
Overrides:
getResource in interface DirectoryScanner
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 © 2000-2006 Apache Software Foundation. All Rights Reserved.