View Javadoc

    1   /*
    2    * $Header: /home/projects/groovy/scm/groovy/groovy-core/src/main/org/codehaus/groovy/ant/FileIterator.java,v 1.1 2003/12/10 18:08:17 jstrachan Exp $
    3    * $Revision: 1.1 $
    4    * $Date: 2003/12/10 18:08:17 $
    5    *
    6    * ====================================================================
    7    *
    8    * The Apache Software License, Version 1.1
    9    *
    10   * Copyright (c) 2002 The Apache Software Foundation.  All rights
    11   * reserved.
    12   *
    13   * Redistribution and use in source and binary forms, with or without
    14   * modification, are permitted provided that the following conditions
    15   * are met:
    16   *
    17   * 1. Redistributions of source code must retain the above copyright
    18   *    notice, this list of conditions and the following disclaimer.
    19   *
    20   * 2. Redistributions in binary form must reproduce the above copyright
    21   *    notice, this list of conditions and the following disclaimer in
    22   *    the documentation and/or other materials provided with the
    23   *    distribution.
    24   *
    25   * 3. The end-user documentation included with the redistribution, if
    26   *    any, must include the following acknowlegement:
    27   *       "This product includes software developed by the
    28   *        Apache Software Foundation (http://www.apache.org/)."
    29   *    Alternately, this acknowlegement may appear in the software itself,
    30   *    if and wherever such third-party acknowlegements normally appear.
    31   *
    32   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
    33   *    Foundation" must not be used to endorse or promote products derived
    34   *    from this software without prior written permission. For written
    35   *    permission, please contact apache@apache.org.
    36   *
    37   * 5. Products derived from this software may not be called "Apache"
    38   *    nor may "Apache" appear in their names without prior written
    39   *    permission of the Apache Group.
    40   *
    41   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    42   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    43   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    44   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    45   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    46   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    47   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    48   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    49   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    50   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    51   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    52   * SUCH DAMAGE.
    53   * ====================================================================
    54   *
    55   * This software consists of voluntary contributions made by many
    56   * individuals on behalf of the Apache Software Foundation.  For more
    57   * information on the Apache Software Foundation, please see
    58   * <http://www.apache.org/>.
    59   *
    60   * $Id: FileIterator.java,v 1.1 2003/12/10 18:08:17 jstrachan Exp $
    61   */
    62  package org.codehaus.groovy.ant;
    63
    64  import java.io.File;
    65  import java.util.Iterator;
    66  import java.util.NoSuchElementException;
    67
    68  import org.apache.tools.ant.DirectoryScanner;
    69  import org.apache.tools.ant.Project;
    70  import org.apache.tools.ant.types.FileSet;
    71
    72  /***
    73   * <p><code>FileIterator</code> is an iterator over a
    74   * over a number of files from a colleciton of FileSet instances.
    75   *
    76   * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
    77   * @version $Revision: 1.1 $
    78   */
    79  public class FileIterator implements Iterator {
    80
    81      /*** The iterator over the FileSet objects */
    82      private Iterator fileSetIterator;
    83
    84      /*** The Ant project */
    85      private Project project;
    86
    87      /*** The directory scanner */
    88      private DirectoryScanner ds;
    89
    90      /*** The file names in the current FileSet scan */
    91      private String[] files;
    92
    93      /*** The current index into the file name array */
    94      private int fileIndex = -1;
    95
    96      /*** The next File object we'll iterate over */
    97      private File nextFile;
    98
    99      /*** Have we set a next object? */
    100     private boolean nextObjectSet = false;
    101
    102     /*** Return only directories? */
    103     private boolean iterateDirectories = false;
    104
    105     public FileIterator(Project project,
    106                         Iterator fileSetIterator) {
    107         this( project, fileSetIterator, false);
    108     }
    109
    110     public FileIterator(Project project,
    111                         Iterator fileSetIterator,
    112                         boolean iterateDirectories) {
    113         this.project = project;
    114         this.fileSetIterator = fileSetIterator;
    115         this.iterateDirectories = iterateDirectories;
    116     }
    117
    118     // Iterator interface
    119     //-------------------------------------------------------------------------
    120
    121     /*** @return true if there is another object that matches the given predicate */
    122     public boolean hasNext() {
    123         if ( nextObjectSet ) {
    124             return true;
    125         }
    126         else {
    127             return setNextObject();
    128         }
    129     }
    130
    131     /*** @return the next object which matches the given predicate */
    132     public Object next() {
    133         if ( !nextObjectSet ) {
    134             if (!setNextObject()) {
    135                 throw new NoSuchElementException();
    136             }
    137         }
    138         nextObjectSet = false;
    139         return nextFile;
    140     }
    141
    142     /***
    143      * throws UnsupportedOperationException
    144      */
    145     public void remove() {
    146         throw new UnsupportedOperationException();
    147     }
    148
    149     // Implementation methods
    150     //-------------------------------------------------------------------------
    151
    152     /***
    153      * Set nextObject to the next object. If there are no more
    154      * objects then return false. Otherwise, return true.
    155      */
    156     private boolean setNextObject() {
    157         while (true) {
    158             while (ds == null) {
    159                 if ( ! fileSetIterator.hasNext() ) {
    160                     return false;
    161                 }
    162                 FileSet fs = (FileSet) fileSetIterator.next();
    163                 ds = fs.getDirectoryScanner(project);
    164                 ds.scan();
    165                 if (iterateDirectories) {
    166                     files = ds.getIncludedDirectories();
    167                 }
    168                 else {
    169                     files = ds.getIncludedFiles();
    170                 }
    171                 if ( files.length > 0 ) {
    172                     fileIndex = -1;
    173                     break;
    174                 }
    175                 else {
    176                     ds = null;
    177                 }
    178             }
    179
    180             if ( ds != null && files != null ) {
    181                 if ( ++fileIndex < files.length ) {
    182                     nextFile = new File( ds.getBasedir(), files[fileIndex] );
    183                     nextObjectSet = true;
    184                     return true;
    185                 }
    186                 else {
    187                     ds = null;
    188                 }
    189             }
    190         }
    191     }
    192 }
    193
    194