001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar 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     * Sonar 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
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
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 get all extension points.
026     * <p/>
027     * <p>The manifest property <code>Plugin-Class</code> must declare the name of the implementation class.
028     * See META-INF/MANIFEST.MF.</p>
029     *
030     * @see org.sonar.api.Extension
031     * @since 1.10
032     */
033    public interface Plugin {
034    
035      /**
036       * Unique key within sonar plugins
037       * @deprecated since 2.2. The key must be set in the manifest.
038       */
039      @Deprecated
040      String getKey();
041    
042      /**
043       * Descriptive name
044       * @deprecated since 2.2. The name must be set in the manifest.
045       */
046      @Deprecated
047      String getName();
048    
049      /**
050       * description of the plugin, can contains html or ruby code
051       * @deprecated since 2.2. The description must be set in the manifest.
052       */
053      @Deprecated
054      String getDescription();
055    
056      /**
057       * Classes of the implemented extensions.
058       */
059      List getExtensions();
060    
061    }