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: * Information about a file, that is used to select files during the
21: * traversal of a hierarchy.
22: *
23: * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
24: * @version $Revision: 480428 $ $Date: 2006-11-28 22:15:24 -0800 (Tue, 28 Nov 2006) $
25: * @todo Rename this interface, as it is used by both FileSelector and FileVisitor.
26: */
27: public interface FileSelectInfo {
28: /**
29: * Returns the base folder of the traversal.
30: */
31: FileObject getBaseFolder();
32:
33: /**
34: * Returns the file (or folder) to be considered.
35: */
36: FileObject getFile();
37:
38: /**
39: * Returns the depth of the file relative to the base folder.
40: */
41: int getDepth();
42: }
|