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 * A {@link FileSelector} that selects files of a particular type.
021 */
022public class FileTypeSelector implements FileSelector {
023
024    /** The FileType */
025    private final FileType type;
026
027    /**
028     * Creates a new selector for the given file type.
029     *
030     * @param type The file type to select
031     */
032    public FileTypeSelector(final FileType type) {
033        this.type = type;
034    }
035
036    /**
037     * Determines if a file or folder should be selected.
038     *
039     * @param fileInfo The file selection information.
040     * @return true if the file or folder should be selected.
041     * @throws FileSystemException if an error occurs
042     */
043    @Override
044    public boolean includeFile(final FileSelectInfo fileInfo) throws Exception {
045        return fileInfo.getFile().getType() == type;
046    }
047
048    /**
049     * Determines whether a folder should be traversed.
050     *
051     * @param fileInfo The file selection information.
052     * @return true if the file or folder should be traversed.
053     */
054    @Override
055    public boolean traverseDescendents(final FileSelectInfo fileInfo) throws Exception {
056        return true;
057    }
058}