Class ArchiveScanner

  • All Implemented Interfaces:
    FileScanner, ResourceFactory, SelectorScanner
    Direct Known Subclasses:
    TarScanner, ZipScanner

    public abstract class ArchiveScanner
    extends DirectoryScanner
    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.
    Since:
    Ant 1.7
    • Field Detail

      • srcFile

        protected java.io.File srcFile
        The archive file which should be scanned.
    • Constructor Detail

      • ArchiveScanner

        public ArchiveScanner()
    • Method Detail

      • setErrorOnMissingArchive

        public void setErrorOnMissingArchive​(boolean errorOnMissingArchive)
        Sets whether an error is thrown if an archive does not exist.
        Parameters:
        errorOnMissingArchive - true if missing archives cause errors, false if not.
        Since:
        Ant 1.8.0
      • setSrc

        public void setSrc​(java.io.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) archive file name for scanning
      • setSrc

        public void setSrc​(Resource src)
        Sets the src for scanning. This is the jar or zip file that is scanned for matching entries.
        Parameters:
        src - the (non-null) archive resource
      • setEncoding

        public void setEncoding​(java.lang.String encoding)
        Sets encoding of file names.
        Parameters:
        encoding - the encoding format
        Since:
        Ant 1.6
      • getIncludedFiles

        public 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. The names are relative to the base directory.
        Specified by:
        getIncludedFiles in interface FileScanner
        Overrides:
        getIncludedFiles in class DirectoryScanner
        Returns:
        the names of the files which matched at least one of the include patterns and none of the exclude patterns.
      • getIncludedFilesCount

        public int getIncludedFilesCount()
        Override parent implementation.
        Overrides:
        getIncludedFilesCount in class DirectoryScanner
        Returns:
        count of included files.
        Since:
        Ant 1.7
      • getIncludedDirectories

        public 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. The names are relative to the base directory.
        Specified by:
        getIncludedDirectories in interface FileScanner
        Overrides:
        getIncludedDirectories in class DirectoryScanner
        Returns:
        the names of the directories which matched at least one of the include patterns and none of the exclude patterns.
      • getIncludedDirsCount

        public int getIncludedDirsCount()
        Override parent implementation.
        Overrides:
        getIncludedDirsCount in class DirectoryScanner
        Returns:
        count of included directories.
        Since:
        Ant 1.7
      • init

        public void init()
        Initialize DirectoryScanner data structures.
      • match

        public boolean match​(java.lang.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.
      • fillMapsFromArchive

        protected abstract void fillMapsFromArchive​(Resource archive,
                                                    java.lang.String encoding,
                                                    java.util.Map<java.lang.String,​Resource> fileEntries,
                                                    java.util.Map<java.lang.String,​Resource> matchFileEntries,
                                                    java.util.Map<java.lang.String,​Resource> dirEntries,
                                                    java.util.Map<java.lang.String,​Resource> matchDirEntries)
        Fills the file and directory maps with resources read from the archive.
        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.
      • trimSeparator

        protected static final java.lang.String trimSeparator​(java.lang.String s)
        Remove trailing slash if present.
        Parameters:
        s - the file name to trim.
        Returns:
        the trimmed file name.