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.batch.ResourceFilter;
025    import org.sonar.api.resources.Resource;
026    import org.sonar.api.resources.Scopes;
027    
028    /**
029     * @since 1.12
030     */
031    public class ResourceFilters {
032    
033      private static final Logger LOG = LoggerFactory.getLogger(ResourceFilters.class);
034    
035      private ResourceFilter[] filters;
036    
037      public ResourceFilters(ResourceFilter[] filters) {
038        this.filters = (filters == null ? new ResourceFilter[0] : filters);
039      }
040    
041      public ResourceFilters() {
042        this(null);
043      }
044    
045      public ResourceFilter[] getFilters() {
046        return filters;
047      }
048    
049      /**
050       * Return true if the violation must be saved. If false then it is ignored.
051       */
052      public boolean isExcluded(Resource resource) {
053        boolean ignored = false;
054        if (Scopes.isHigherThanOrEquals(resource, Scopes.FILE)) {
055          int index = 0;
056          while (!ignored && index < filters.length) {
057            ResourceFilter filter = filters[index];
058            ignored = filter.isIgnored(resource);
059            if (ignored && LOG.isDebugEnabled()) {
060              LOG.debug("Resource {} is excluded by the filter {}", resource, filter);
061            }
062            index++;
063          }
064        }
065        return ignored;
066      }
067    
068    }