View Javadoc

1   /*
2    * $Header: /home/projects/groovy/scm/groovy/groovy-core/src/main/org/codehaus/groovy/ant/FileScanner.java,v 1.2 2006/06/07 12:44:42 dierk Exp $
3    * $Revision: 1.2 $
4    * $Date: 2006/06/07 12:44:42 $
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: FileScanner.java,v 1.2 2006/06/07 12:44:42 dierk Exp $
61   */
62  package org.codehaus.groovy.ant;
63  
64  import java.util.ArrayList;
65  import java.util.Iterator;
66  import java.util.List;
67  
68  import org.apache.tools.ant.Project;
69  import org.apache.tools.ant.Task;
70  import org.apache.tools.ant.types.FileSet;
71  
72  /*** 
73   * <p><code>FileScanner</code> is a bean which allows the iteration
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   * @author Marc Guillemot
78   * @version $Revision: 1.2 $
79   */
80  public class FileScanner extends Task {
81  
82      /*** FileSets */
83      private List filesets = new ArrayList();
84  
85      public FileScanner() {
86      }
87      
88      public FileScanner(final Project project) {
89          setProject(project);
90      }
91      
92      public Iterator iterator() {
93          return new FileIterator(getProject(), filesets.iterator());
94      }
95  
96      public Iterator directories() {
97          return new FileIterator(getProject(), filesets.iterator(), true);
98      }
99  
100     public boolean hasFiles() {
101         return filesets.size() > 0;
102     }
103 
104     /***
105      * Clears any file sets that have been added to this scanner
106      */
107     public void clear() {
108         filesets.clear();
109     }
110 
111     // Properties
112     //-------------------------------------------------------------------------
113 
114     /***
115      * Adds a set of files (nested fileset attribute).
116      */
117     public void addFileset(FileSet set) {
118         filesets.add(set);
119     }
120 
121 }