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 * @version $Id: MojoDescriptorExtractor.html 1024032 2018-01-19 18:16:30Z hboutemy $
31 */
32 public interface MojoDescriptorExtractor
33 {
34 /** Plexus role for lookup */
35 String ROLE = MojoDescriptorExtractor.class.getName();
36
37 /**
38 * Execute the mojo extraction.
39 *
40 * @param request The {@link PluginToolsRequest} containing information for the extraction process.
41 * @return a list of mojo descriptors.
42 * @throws ExtractionException if any
43 * @throws InvalidPluginDescriptorException if any
44 * @since 2.5
45 */
46 List<MojoDescriptor> execute( PluginToolsRequest request )
47 throws ExtractionException, InvalidPluginDescriptorException;
48 }