View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.vfs2;
18  
19  /**
20   * A {@link FileSelector} that selects files of a particular type.
21   */
22  public class FileTypeSelector implements FileSelector {
23  
24      /** The FileType */
25      private final FileType type;
26  
27      /**
28       * Creates a new selector for the given file type.
29       *
30       * @param type The file type to select
31       */
32      public FileTypeSelector(final FileType type) {
33          this.type = type;
34      }
35  
36      /**
37       * Determines if a file or folder should be selected.
38       *
39       * @param fileInfo The file selection information.
40       * @return true if the file or folder should be selected.
41       * @throws FileSystemException if an error occurs
42       */
43      @Override
44      public boolean includeFile(final FileSelectInfo fileInfo) throws Exception {
45          return fileInfo.getFile().getType() == type;
46      }
47  
48      /**
49       * Determines whether a folder should be traversed.
50       *
51       * @param fileInfo The file selection information.
52       * @return true if the file or folder should be traversed.
53       */
54      @Override
55      public boolean traverseDescendents(final FileSelectInfo fileInfo) throws Exception {
56          return true;
57      }
58  }