001package org.apache.maven.tools.plugin.scanner;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException;
023import org.apache.maven.tools.plugin.PluginToolsRequest;
024import org.apache.maven.tools.plugin.extractor.ExtractionException;
025
026import java.util.Set;
027
028/**
029 * @author jdcasey
030 *
031 */
032public interface MojoScanner
033{
034    /** Plexus role for lookup */
035    String ROLE = MojoScanner.class.getName();
036
037    /**
038     * @param request not null
039     * @throws ExtractionException if any
040     * @throws InvalidPluginDescriptorException if any
041     * @since 2.5
042     */
043    void populatePluginDescriptor( PluginToolsRequest request )
044        throws ExtractionException, InvalidPluginDescriptorException;
045
046    /**
047     * <p>
048     * Sets the active extractors.
049     * </p>
050     * <p>
051     * Only the specified extractors will be used, all others will be skipped.
052     * </p>
053     * @param extractors The names of the active extractors. If this parameter is <code>null</code>,
054     * all the scanner's extractors are considered active. Set entries that are <code>null</code> or
055     * empty ("") will be ignored.
056     */
057    void setActiveExtractors( Set<String> extractors );
058
059}