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