View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.utils;
21  
22  import java.io.IOException;
23  import java.io.InputStream;
24  
25  import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
26  
27  /**
28   * Utility methods for suppression filters.
29   *
30   */
31  public final class FilterUtil {
32  
33      /** Stop instances being created. **/
34      private FilterUtil() {
35      }
36  
37      /**
38       * Checks if suppression source with given fileName exists.
39       *
40       * @param fileName name of the suppressions file.
41       * @return true if suppression file exists, otherwise false
42       */
43      public static boolean isFileExists(String fileName) {
44          boolean suppressionSourceExists;
45          try (InputStream stream = CommonUtil.getUriByFilename(fileName).toURL().openStream()) {
46              suppressionSourceExists = true;
47          }
48          catch (CheckstyleException | IOException ignored) {
49              suppressionSourceExists = false;
50          }
51          return suppressionSourceExists;
52      }
53  
54  }