001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube 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 * SonarQube 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 License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.batch.rule;
021
022import com.google.common.annotations.Beta;
023import org.sonar.api.rule.RuleKey;
024import org.sonar.api.rule.RuleStatus;
025
026import javax.annotation.CheckForNull;
027import java.util.Collection;
028
029/**
030 * Not used
031 * @since 4.2
032 */
033@Beta
034public interface Rule {
035
036  RuleKey key();
037
038  String name();
039
040  @CheckForNull
041  String description();
042
043  @CheckForNull
044  String metadata();
045
046  String severity();
047
048  @CheckForNull
049  RuleParam param(String paramKey);
050
051  Collection<RuleParam> params();
052
053  RuleStatus status();
054
055}