sonarqube/plugins/sonar-checkstyle-plugin/src/main/java/org/sonar/plugins/checkstyle/CheckstylePlugin.java

/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2009 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * Sonar 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.
 *
 * Sonar 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 Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.checkstyle;

import org.sonar.api.CoreProperties;
import org.sonar.api.Plugin;
import org.sonar.api.Properties;
import org.sonar.api.Property;
import org.sonar.api.profiles.RulesProfile;
import org.sonar.api.profiles.XMLProfileDefinition;
import org.sonar.api.resources.Java;

import java.util.Arrays;
import java.util.List;

@Properties( { 
  @Property(key = CheckstyleConstants.FILTERS_KEY,
      defaultValue = CheckstyleConstants.FILTERS_DEFAULT_VALUE,
      name = "Filters", 
      description = "Checkstyle support three error filtering mechanisms : SuppressionCommentFilter, SuppressWithNearbyCommentFilter and SuppressionFilter."
        + "This property allows to configure all those filters with a native XML format."
          + " See <a href='http://checkstyle.sourceforge.net/config.html'>Checkstyle configuration page</a> to get more information on those filters.", 
          project = false, global = true) })
public class CheckstylePlugin implements Plugin {

  public String getKey() {
    return CoreProperties.CHECKSTYLE_PLUGIN;
  }

  public String getName() {
    return CheckstyleConstants.PLUGIN_NAME;
  }

  public String getDescription() {
    return "Checkstyle is a rule engine that helps programmers writing Java code that adheres to a coding standard. " +
        "You can find more by going to the <a href='http://checkstyle.sourceforge.net'>Checkstyle web site</a>.";
  }

  public List getExtensions() {
    return Arrays.asList(
        CheckstyleSensor.class,
        CheckstyleConfiguration.class,
        CheckstyleExecutor.class,
        CheckstyleAuditListener.class,
        CheckstyleProfileExporter.class,
        CheckstyleRuleRepository.class,
        SonarWayProfile.class,
        SunConventionsProfile.class,
        SonarWayWithFindbugsProfile.class);
  }
}