1 package org.apache.maven.tools.plugin.scanner;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException;
23 import org.apache.maven.tools.plugin.PluginToolsRequest;
24 import org.apache.maven.tools.plugin.extractor.ExtractionException;
25
26 import java.util.Set;
27
28 /**
29 * @author jdcasey
30 * @version $Id: MojoScanner.html 1024032 2018-01-19 18:16:30Z hboutemy $
31 */
32 public interface MojoScanner
33 {
34 /** Plexus role for lookup */
35 String ROLE = MojoScanner.class.getName();
36
37 /**
38 * @param request not null
39 * @throws ExtractionException if any
40 * @throws InvalidPluginDescriptorException if any
41 * @since 2.5
42 */
43 void populatePluginDescriptor( PluginToolsRequest request )
44 throws ExtractionException, InvalidPluginDescriptorException;
45
46 /**
47 * Sets the active extractors.
48 * <p/>
49 * Only the specified extractors will be used, all others will be skipped.
50 *
51 * @param extractors The names of the active extractors. If this parameter is <code>null</code>,
52 * all the scanner's extractors are considered active. Set entries that are <code>null</code> or
53 * empty ("") will be ignored.
54 */
55 void setActiveExtractors( Set<String> extractors );
56
57 }