001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.batch;
021    
022    import org.slf4j.Logger;
023    import org.slf4j.LoggerFactory;
024    import org.sonar.api.rules.Violation;
025    import org.sonar.api.rules.ViolationFilter;
026    
027    public class ViolationFilters {
028    
029      private static final Logger LOG = LoggerFactory.getLogger(ViolationFilters.class);
030      
031      private ViolationFilter[] filters;
032    
033      public ViolationFilters(ViolationFilter[] filters) {
034        this.filters = (filters==null ? new ViolationFilter[0] : filters);
035      }
036    
037      public ViolationFilters() {
038        this(null);
039      }
040    
041      public ViolationFilter[] getFilters() {
042        return filters;
043      }
044    
045      /**
046       * Return true if the violation must be saved. If false then it is ignored.
047       */
048      public boolean isIgnored(Violation violation) {
049        boolean ignored = false;
050        int index = 0;
051        while (!ignored && index < filters.length) {
052          ignored = filters[index].isIgnored(violation);
053          if (ignored && LOG.isDebugEnabled()) {
054            LOG.debug("Violation {} is excluded by the filter {}", violation, filters[index]);
055          }
056          index++;
057        }
058        return ignored;
059      }
060    }