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 */
020package org.sonar.api.rules;
021
022import org.sonar.api.BatchExtension;
023import org.sonar.api.batch.DecoratorBarriers;
024import org.sonar.api.batch.DependedUpon;
025
026/**
027 * Filter violations to save. For example, ignore a violation if it occurs on a line of code commented with //NOSONAR
028 *
029 * @since 1.12
030 */
031@DependedUpon(value = DecoratorBarriers.START_VIOLATIONS_GENERATION)
032public interface ViolationFilter extends BatchExtension {
033
034  /**
035   * Return true if the violation must be ignored, else it's saved into database.
036   */
037  boolean isIgnored(Violation violation);
038
039}