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.api;
21  
22  import java.util.Collections;
23  import java.util.HashSet;
24  import java.util.Set;
25  
26  /**
27   * A filter set applies filters to AuditEvents.
28   * If a filter in the set rejects an AuditEvent, then the
29   * AuditEvent is rejected. Otherwise, the AuditEvent is accepted.
30   */
31  public class FilterSet
32      implements Filter {
33  
34      /** Filter set. */
35      private final Set<Filter> filters = new HashSet<>();
36  
37      /**
38       * Adds a Filter to the set.
39       *
40       * @param filter the Filter to add.
41       */
42      public void addFilter(Filter filter) {
43          filters.add(filter);
44      }
45  
46      /**
47       * Removes filter.
48       *
49       * @param filter filter to remove.
50       */
51      public void removeFilter(Filter filter) {
52          filters.remove(filter);
53      }
54  
55      /**
56       * Returns the Filters of the filter set.
57       *
58       * @return the Filters of the filter set.
59       */
60      public Set<Filter> getFilters() {
61          return Collections.unmodifiableSet(filters);
62      }
63  
64      @Override
65      public String toString() {
66          return filters.toString();
67      }
68  
69      @Override
70      public boolean accept(AuditEvent event) {
71          boolean result = true;
72          for (Filter filter : filters) {
73              if (!filter.accept(event)) {
74                  result = false;
75                  break;
76              }
77          }
78          return result;
79      }
80  
81      /** Clears the FilterSet. */
82      public void clear() {
83          filters.clear();
84      }
85  
86  }