org.sonar.api.rules.ViolationFilter Maven / Gradle / Ivy
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* SonarQube is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.rules;
import org.sonar.api.BatchExtension;
import org.sonar.api.batch.DecoratorBarriers;
import org.sonar.api.batch.DependedUpon;
/**
* Filter violations to save. For example, ignore a violation if it occurs on a line of code commented with //NOSONAR
*
* @since 1.12
* @deprecated in 3.6. Replaced by {@link org.sonar.api.issue.IssueFilter}.
*/
@DependedUpon(value = DecoratorBarriers.START_VIOLATIONS_GENERATION)
@Deprecated
public interface ViolationFilter extends BatchExtension {
/**
* Return true if the violation must be ignored, else it's saved into database.
*/
boolean isIgnored(Violation violation);
}