001 /* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 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 */ 020 package org.sonar.api; 021 022 /** 023 * Plugin entry-point used to declare its extensions (see {@link org.sonar.api.Extension}. 024 * <p/> 025 * <p>The JAR manifest must declare the name of the implementation class in the property <code>Plugin-Class</code>. 026 * This property is automatically set by sonar-packaging-maven-plugin when building plugin.</p> 027 * 028 * @since 2.8 029 */ 030 public abstract class SonarPlugin implements Plugin { 031 032 public final String getKey() { 033 throw new UnsupportedOperationException(); 034 } 035 036 public final String getName() { 037 throw new UnsupportedOperationException(); 038 } 039 040 public final String getDescription() { 041 throw new UnsupportedOperationException(); 042 } 043 044 /** 045 * Returns a string representation of the plugin, suitable for debugging purposes only. 046 */ 047 @Override 048 public String toString() { 049 return getClass().getSimpleName(); 050 } 051 052 }