org.apache.ant.compress.resources
Class CommonsCompressArchiveScanner

java.lang.Object
  extended by org.apache.tools.ant.DirectoryScanner
      extended by org.apache.tools.ant.types.ArchiveScanner
          extended by org.apache.ant.compress.resources.CommonsCompressArchiveScanner
All Implemented Interfaces:
org.apache.tools.ant.FileScanner, org.apache.tools.ant.types.ResourceFactory, org.apache.tools.ant.types.selectors.SelectorScanner
Direct Known Subclasses:
ZipScanner

public class CommonsCompressArchiveScanner
extends org.apache.tools.ant.types.ArchiveScanner

Scans tar archives for resources.


Nested Class Summary
static interface CommonsCompressArchiveScanner.ResourceBuilder
           
 
Field Summary
 
Fields inherited from class org.apache.tools.ant.types.ArchiveScanner
srcFile
 
Fields inherited from class org.apache.tools.ant.DirectoryScanner
basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors
 
Constructor Summary
CommonsCompressArchiveScanner(ArchiveStreamFactory factory, CommonsCompressArchiveScanner.ResourceBuilder builder)
           
CommonsCompressArchiveScanner(ArchiveStreamFactory factory, CommonsCompressArchiveScanner.ResourceBuilder builder, boolean skipUnreadableEntries, org.apache.tools.ant.Project project)
           
 
Method Summary
protected  void fillMapsFromArchive(org.apache.tools.ant.types.Resource src, 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.
 boolean getSkipUnreadableEntries()
          Whether to skip entries that Commons Compress signals it cannot read.
protected  void log(java.lang.String msg)
           
 
Methods inherited from class org.apache.tools.ant.types.ArchiveScanner
getIncludedDirectories, getIncludedDirsCount, getIncludedFiles, getIncludedFilesCount, getResource, init, match, scan, setEncoding, setErrorOnMissingArchive, setSrc, setSrc, trimSeparator
 
Methods inherited from class org.apache.tools.ant.DirectoryScanner
addDefaultExclude, addDefaultExcludes, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getNotFollowedSymlinks, getNotIncludedDirectories, getNotIncludedFiles, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setCaseSensitive, setErrorOnMissingDir, setExcludes, setFollowSymlinks, setIncludes, setMaxLevelsOfSymlinks, setSelectors, slowScan
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommonsCompressArchiveScanner

public CommonsCompressArchiveScanner(ArchiveStreamFactory factory,
                                     CommonsCompressArchiveScanner.ResourceBuilder builder)

CommonsCompressArchiveScanner

public CommonsCompressArchiveScanner(ArchiveStreamFactory factory,
                                     CommonsCompressArchiveScanner.ResourceBuilder builder,
                                     boolean skipUnreadableEntries,
                                     org.apache.tools.ant.Project project)
Method Detail

getSkipUnreadableEntries

public boolean getSkipUnreadableEntries()
Whether to skip entries that Commons Compress signals it cannot read.

Since:
Compress Antlib 1.1

fillMapsFromArchive

protected void fillMapsFromArchive(org.apache.tools.ant.types.Resource src,
                                   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.

Specified by:
fillMapsFromArchive in class org.apache.tools.ant.types.ArchiveScanner
Parameters:
src - 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.

log

protected final void log(java.lang.String msg)
Since:
Compress Antlib 1.1