trunk/core/src/main/java/org/apache/commons/vfs2/FileDepthSelector.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;

/**
 * A {@link FileSelector} that selects all files in a particular depth range.
 */
public class FileDepthSelector implements FileSelector
{
    /**
     * The minimum depth
     */
    private final int minDepth;

    /**
     * The maximum depth
     */
    private final int maxDepth;

    /**
     * Creates a selector with the given minimum and maximum depths.
     *
     * @param minDepth
     *            minimum depth
     * @param maxDepth
     *            maximum depth
     */
    public FileDepthSelector(final int minDepth, final int maxDepth)
    {
        this.minDepth = minDepth;
        this.maxDepth = maxDepth;
    }

    /**
     * Creates a selector with the same minimum and maximum depths.
     *
     * @param minMaxDepth
     *            minimum and maximum depth
     * @since 2.1
     */
    public FileDepthSelector(final int minMaxDepth)
    {
        this(minMaxDepth, minMaxDepth);
    }

    /**
     * Creates a selector with the same minimum and maximum depths of 0.
     *
     * @since 2.1
     */
    public FileDepthSelector()
    {
        this(0, 0);
    }

    /**
     * Determines if a file or folder should be selected.
     *
     * @param fileInfo
     *            The file selection information
     * @return true if the file or folder should be included, false otherwise.
     */
    @Override
    public boolean includeFile(final FileSelectInfo fileInfo)
    {
        final int depth = fileInfo.getDepth();
        return minDepth <= depth && depth <= maxDepth;
    }

    /**
     * Determines whether a folder should be traversed.
     *
     * @param fileInfo
     *            The file selection information
     * @return true if the file or folder should be traversed, false otherwise.
     */
    @Override
    public boolean traverseDescendents(final FileSelectInfo fileInfo)
    {
        return fileInfo.getDepth() < maxDepth;
    }
}