commons-vfs2/src/main/java/org/apache/commons/vfs2/FileSelectInfo.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.vfs2;

/**
 * Information about a file, that is used to select files during the traversal of a hierarchy.
 * <p>
 * TODO - Rename this interface, as it is used by both FileSelector and FileVisitor.
 * </p>
 */
public interface FileSelectInfo {

    /**
     * Gets the base folder of the traversal.
     *
     * @return FileObject representing the base folder.
     */
    FileObject getBaseFolder();

    /**
     * Gets the depth of the file relative to the base folder.
     *
     * @return The depth of the file relative to the base folder.
     */
    int getDepth();

    /**
     * Gets the file (or folder) to be considered.
     *
     * @return The FileObject.
     */
    FileObject getFile();
}