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.plugin.descriptor.PluginDescriptor; 25 import org.apache.maven.project.MavenProject; 26 import org.apache.maven.tools.plugin.PluginToolsRequest; 27 28 import java.util.List; 29 30 /** 31 * @author jdcasey 32 * @version $Id: MojoDescriptorExtractor.java 1133707 2011-06-09 08:28:59Z stephenc $ 33 */ 34 public interface MojoDescriptorExtractor 35 { 36 /** Plexus role for lookup */ 37 String ROLE = MojoDescriptorExtractor.class.getName(); 38 39 40 /** 41 * Execute the mojo extraction. 42 * 43 * @return a list of mojo descriptors. 44 * @throws ExtractionException if any 45 * @throws InvalidPluginDescriptorException if any 46 * 47 * @deprecated Use {@link MojoDescriptorExtractor#execute(PluginToolsRequest)} instead. 48 * Provided for backward compatibility with maven-plugin-plugin < 2.5. 49 */ 50 List<MojoDescriptor> execute( MavenProject project, PluginDescriptor pluginDescriptor ) 51 throws ExtractionException, InvalidPluginDescriptorException; 52 53 /** 54 * Execute the mojo extraction. 55 * 56 * @param request The {@link PluginToolsRequest} containing information for the extraction process. 57 * @return a list of mojo descriptors. 58 * @throws ExtractionException if any 59 * @throws InvalidPluginDescriptorException if any 60 * @since 2.5 61 */ 62 List<MojoDescriptor> execute( PluginToolsRequest request ) 63 throws ExtractionException, InvalidPluginDescriptorException; 64 }