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 import java.util.List;
023
024 /**
025 * A plugin is a group of extensions. See <code>org.sonar.api.Extension</code> interface to browse
026 * available extension points.
027 * <p/>
028 * <p>The manifest property <code>Plugin-Class</code> must declare the name of the implementation class.
029 * It is automatically set by sonar-packaging-maven-plugin when building plugins.</p>
030 *
031 * @see org.sonar.api.Extension
032 * @since 1.10
033 * @deprecated in 2.8. Use {@link SonarPlugin} instead.
034 */
035 @Deprecated
036 public interface Plugin {
037
038 /**
039 * Unique key within sonar plugins
040 * @deprecated since 2.2. The key must be set in the manifest.
041 */
042 @Deprecated
043 String getKey();
044
045 /**
046 * Descriptive name
047 * @deprecated since 2.2. The name must be set in the manifest.
048 */
049 @Deprecated
050 String getName();
051
052 /**
053 * description of the plugin, can contains html or ruby code
054 * @deprecated since 2.2. The description must be set in the manifest.
055 */
056 @Deprecated
057 String getDescription();
058
059 /**
060 * Classes of the implemented extensions.
061 */
062 List getExtensions();
063
064 }