001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.commons.vfs2; 018 019/** 020 * Information about a file, that is used to select files during the traversal of a hierarchy. 021 * <p> 022 * TODO - Rename this interface, as it is used by both FileSelector and FileVisitor. 023 */ 024public interface FileSelectInfo { 025 /** 026 * Returns the base folder of the traversal. 027 * 028 * @return FileObject representing the base folder. 029 */ 030 FileObject getBaseFolder(); 031 032 /** 033 * Returns the file (or folder) to be considered. 034 * 035 * @return The FileObject. 036 */ 037 FileObject getFile(); 038 039 /** 040 * Returns the depth of the file relative to the base folder. 041 * 042 * @return The depth of the file relative to the base folder. 043 */ 044 int getDepth(); 045}