1 package org.apache.maven.tools.plugin.extractor;
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.plugin.descriptor.MojoDescriptor;
24 import org.apache.maven.tools.plugin.PluginToolsRequest;
25
26 import java.util.List;
27
28 /**
29 * @author jdcasey
30 */
31 public interface MojoDescriptorExtractor
32 {
33 /**
34 * Returns the "name" (id) of the extractor.
35 *
36 * @since TBD
37 */
38 String getName();
39
40 /**
41 * Returns {@code true} if extractor is deprecated.
42 *
43 * @since TBD
44 */
45 boolean isDeprecated();
46
47 /**
48 * Returns the {@link GroupKey} of extractor, as {@link org.apache.maven.tools.plugin.scanner.MojoScanner} will
49 * execute them grouped, and ordered within groups. Must never return {@code null}.
50 *
51 * @since TBD
52 */
53 GroupKey getGroupKey();
54
55 /**
56 * Execute the mojo extraction.
57 *
58 * @param request The {@link PluginToolsRequest} containing information for the extraction process.
59 * @return a list of mojo descriptors. These may return HTML values for some fields.
60 * @throws ExtractionException if any
61 * @throws InvalidPluginDescriptorException if any
62 * @since 2.5
63 */
64 List<MojoDescriptor> execute( PluginToolsRequest request )
65 throws ExtractionException, InvalidPluginDescriptorException;
66 }