KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > vfs > FileSelectInfo


1 /*
2  * Copyright 2002-2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.commons.vfs;
17
18 /**
19  * Information about a file, that is used to select files during the
20  * traversal of a hierarchy.
21  *
22  * @author <a HREF="mailto:adammurdoch@apache.org">Adam Murdoch</a>
23  * @todo Rename this interface, as it is used by both FileSelector and FileVisitor.
24  */
25 public interface FileSelectInfo
26 {
27     /**
28      * Returns the base folder of the traversal.
29      */
30     FileObject getBaseFolder();
31
32     /**
33      * Returns the file (or folder) to be considered.
34      */
35     FileObject getFile();
36
37     /**
38      * Returns the depth of the file relative to the base folder.
39      */
40     int getDepth();
41 }
42
Popular Tags