View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 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.Objects;
25  import java.util.Set;
26  
27  /**
28   * A filter set applies filters to AuditEvents.
29   * If a filter in the set rejects an AuditEvent, then the
30   * AuditEvent is rejected. Otherwise, the AuditEvent is accepted.
31   * @author Rick Giles
32   */
33  public class FilterSet
34      implements Filter {
35      /** Filter set. */
36      private final Set<Filter> filters = new HashSet<>();
37  
38      /**
39       * Adds a Filter to the set.
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       * @param filter filter to remove.
49       */
50      public void removeFilter(Filter filter) {
51          filters.remove(filter);
52      }
53  
54      /**
55       * Returns the Filters of the filter set.
56       * @return the Filters of the filter set.
57       */
58      public Set<Filter> getFilters() {
59          return Collections.unmodifiableSet(filters);
60      }
61  
62      @Override
63      public String toString() {
64          return filters.toString();
65      }
66  
67      @Override
68      public boolean equals(Object other) {
69          if (this == other) {
70              return true;
71          }
72          if (other == null || getClass() != other.getClass()) {
73              return false;
74          }
75          final FilterSet filterSet = (FilterSet) other;
76          return Objects.equals(filters, filterSet.filters);
77      }
78  
79      @Override
80      public int hashCode() {
81          return Objects.hash(filters);
82      }
83  
84      @Override
85      public boolean accept(AuditEvent event) {
86          boolean result = true;
87          for (Filter filter : filters) {
88              if (!filter.accept(event)) {
89                  result = false;
90                  break;
91              }
92          }
93          return result;
94      }
95  
96      /** Clears the FilterSet. */
97      public void clear() {
98          filters.clear();
99      }
100 }