View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.vfs;
18  
19  /***
20   * This interface is used to select files when traversing a file hierarchy.
21   *
22   * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
23   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
24   * @see Selectors
25   */
26  public interface FileSelector
27  {
28      /***
29       * Determines if a file or folder should be selected.  This method is
30       * called in depthwise order (that is, it is called for the children
31       * of a folder before it is called for the folder itself).
32       *
33       * @param fileInfo the file or folder to select.
34       * @return true if the file should be selected.
35       */
36      boolean includeFile(FileSelectInfo fileInfo)
37          throws Exception;
38  
39      /***
40       * Determines whether a folder should be traversed.  If this method returns
41       * true, {@link #includeFile} is called for each of the children of
42       * the folder, and each of the child folders is recursively traversed.
43       * <p/>
44       * <p>This method is called on a folder before {@link #includeFile}
45       * is called.
46       *
47       * @param fileInfo the file or folder to select.
48       * @return true if the folder should be traversed.
49       */
50      boolean traverseDescendents(FileSelectInfo fileInfo)
51          throws Exception;
52  }