org.apache.maven.tools.plugin.scanner.MojoScanner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tesla-plugin-tools-api Show documentation

The Tesla Plugin Tools API provides an API to extract information from and generate documentation for Tesla Plugins.

The newest version!

package org.apache.maven.tools.plugin.scanner;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.project.MavenProject;
import org.apache.maven.tools.plugin.PluginToolsRequest;
import org.apache.maven.tools.plugin.extractor.ExtractionException;

import java.util.Set;

/**
 * @author jdcasey
 * @version $Id: MojoScanner.java 746400 2009-02-20 22:42:13Z bentmann $
 */
public interface MojoScanner
{
    /** Plexus role for lookup */
    String ROLE = MojoScanner.class.getName();

    /**
     * @param project not null
     * @param pluginDescriptor not null
     * @throws ExtractionException if any
     * @throws InvalidPluginDescriptorException if any
     * 
     * @deprecated Use {@link MojoScanner#populatePluginDescriptor(PluginToolsRequest)} instead. 
     *     Provided for backward compatibility with maven-plugin-plugin < 2.5.
     */
    void populatePluginDescriptor( MavenProject project, PluginDescriptor pluginDescriptor )
        throws ExtractionException, InvalidPluginDescriptorException;

    /**
     * @param request not null
     * @throws ExtractionException if any
     * @throws InvalidPluginDescriptorException if any
     * @since 2.5
     */
    void populatePluginDescriptor( PluginToolsRequest request )
        throws ExtractionException, InvalidPluginDescriptorException;

    /**
     * Sets the active extractors.
     * 
     * Only the specified extractors will be used, all others will be skipped.
     *
     * @param extractors The names of the sctive extractors. If this parameter is null,
     * all the scanner's extractors are considered active. Set entries that are null or
     * empty ("") will be ignored.
     */
    void setActiveExtractors( Set/*  */extractors );

}