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