01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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-28 22:15:24 -0800 (Tue, 28 Nov 2006) $
24: * @see Selectors
25: */
26: public interface FileSelector {
27: /**
28: * Determines if a file or folder should be selected. This method is
29: * called in depthwise order (that is, it is called for the children
30: * of a folder before it is called for the folder itself).
31: *
32: * @param fileInfo the file or folder to select.
33: * @return true if the file should be selected.
34: */
35: boolean includeFile(FileSelectInfo fileInfo) throws Exception;
36:
37: /**
38: * Determines whether a folder should be traversed. If this method returns
39: * true, {@link #includeFile} is called for each of the children of
40: * the folder, and each of the child folders is recursively traversed.
41: * <p/>
42: * <p>This method is called on a folder before {@link #includeFile}
43: * is called.
44: *
45: * @param fileInfo the file or folder to select.
46: * @return true if the folder should be traversed.
47: */
48: boolean traverseDescendents(FileSelectInfo fileInfo)
49: throws Exception;
50: }
|