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