001package 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 022import org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException; 023import org.apache.maven.plugin.descriptor.MojoDescriptor; 024import org.apache.maven.tools.plugin.PluginToolsRequest; 025 026import java.util.List; 027 028/** 029 * @author jdcasey 030 * @version $Id: MojoDescriptorExtractor.html 1030109 2018-05-20 14:45:18Z hboutemy $ 031 */ 032public interface MojoDescriptorExtractor 033{ 034 /** Plexus role for lookup */ 035 String ROLE = MojoDescriptorExtractor.class.getName(); 036 037 /** 038 * Execute the mojo extraction. 039 * 040 * @param request The {@link PluginToolsRequest} containing information for the extraction process. 041 * @return a list of mojo descriptors. 042 * @throws ExtractionException if any 043 * @throws InvalidPluginDescriptorException if any 044 * @since 2.5 045 */ 046 List<MojoDescriptor> execute( PluginToolsRequest request ) 047 throws ExtractionException, InvalidPluginDescriptorException; 048}