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.vfs2;
18
19 /**
20 * Information about a file, that is used to select files during the traversal of a hierarchy.
21 * <p>
22 * TODO - Rename this interface, as it is used by both FileSelector and FileVisitor.
23 * </p>
24 */
25 public interface FileSelectInfo {
26
27 /**
28 * Returns the base folder of the traversal.
29 *
30 * @return FileObject representing the base folder.
31 */
32 FileObject getBaseFolder();
33
34 /**
35 * Returns the file (or folder) to be considered.
36 *
37 * @return The FileObject.
38 */
39 FileObject getFile();
40
41 /**
42 * Returns the depth of the file relative to the base folder.
43 *
44 * @return The depth of the file relative to the base folder.
45 */
46 int getDepth();
47 }