001 package org.apache.maven.tools.plugin.extractor; 002 003 /* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022 import org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException; 023 import org.apache.maven.plugin.descriptor.MojoDescriptor; 024 import org.apache.maven.plugin.descriptor.PluginDescriptor; 025 import org.apache.maven.project.MavenProject; 026 import org.apache.maven.tools.plugin.PluginToolsRequest; 027 028 import java.util.List; 029 030 /** 031 * @author jdcasey 032 * @version $Id: MojoDescriptorExtractor.java 1133707 2011-06-09 08:28:59Z stephenc $ 033 */ 034 public interface MojoDescriptorExtractor 035 { 036 /** Plexus role for lookup */ 037 String ROLE = MojoDescriptorExtractor.class.getName(); 038 039 040 /** 041 * Execute the mojo extraction. 042 * 043 * @return a list of mojo descriptors. 044 * @throws ExtractionException if any 045 * @throws InvalidPluginDescriptorException if any 046 * 047 * @deprecated Use {@link MojoDescriptorExtractor#execute(PluginToolsRequest)} instead. 048 * Provided for backward compatibility with maven-plugin-plugin < 2.5. 049 */ 050 List<MojoDescriptor> execute( MavenProject project, PluginDescriptor pluginDescriptor ) 051 throws ExtractionException, InvalidPluginDescriptorException; 052 053 /** 054 * Execute the mojo extraction. 055 * 056 * @param request The {@link PluginToolsRequest} containing information for the extraction process. 057 * @return a list of mojo descriptors. 058 * @throws ExtractionException if any 059 * @throws InvalidPluginDescriptorException if any 060 * @since 2.5 061 */ 062 List<MojoDescriptor> execute( PluginToolsRequest request ) 063 throws ExtractionException, InvalidPluginDescriptorException; 064 }