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  import java.util.regex.Pattern;
20  
21  /**
22   * A {@link FileSelector} that selects based on regular expressions matched against base filename.
23   *
24   * @since 2.1
25   */
26  public class PatternFileSelector implements FileSelector
27  {
28  
29      /**
30       * The extensions to select.
31       */
32      private final Pattern pattern;
33  
34      /**
35       * Creates a new selector for the given pattern.
36       *
37       * @param pattern
38       *            The regular expressed used by this selector.
39       */
40      public PatternFileSelector(final Pattern pattern)
41      {
42          this.pattern = pattern;
43      }
44  
45      /**
46       * Creates a new selector for the given pattern.
47       *
48       * @param regex
49       *            The regular expressed used by this selector.
50       */
51      public PatternFileSelector(final String regex)
52      {
53          this(Pattern.compile(regex));
54      }
55  
56      /**
57       * Creates a new selector for the given Pattern and flags.
58       *
59       * @param regex
60       *            The expression to be compiled
61       *
62       * @param flags
63       *            Match flags, a bit mask.
64       *
65       * @see Pattern#compile(String, int)
66       */
67      public PatternFileSelector(final String regex, final int flags)
68      {
69          this(Pattern.compile(regex, flags));
70      }
71  
72      /**
73       * Determines if a file or folder should be selected.
74       *
75       * @param fileInfo
76       *            The file selection information.
77       * @return true if the file should be selected, false otherwise.
78       */
79      @Override
80      public boolean includeFile(final FileSelectInfo fileInfo)
81      {
82          return this.pattern.matcher(fileInfo.getFile().getName().getPath()).matches();
83      }
84  
85      @Override
86      public String toString()
87      {
88          return this.pattern.toString();
89      }
90  
91      /**
92       * Determines whether a folder should be traversed.
93       *
94       * @param fileInfo
95       *            The file selection information.
96       * @return true if descendants should be traversed, false otherwise.
97       */
98      @Override
99      public boolean traverseDescendents(final FileSelectInfo fileInfo)
100     {
101         return true;
102     }
103 }