001package org.apache.maven.tools.plugin.scanner; 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.tools.plugin.PluginToolsRequest; 024import org.apache.maven.tools.plugin.extractor.ExtractionException; 025 026import java.util.Set; 027 028/** 029 * @author jdcasey 030 * 031 */ 032public interface MojoScanner 033{ 034 /** 035 * @param request not null 036 * @throws ExtractionException if any 037 * @throws InvalidPluginDescriptorException if any 038 * @since 2.5 039 */ 040 void populatePluginDescriptor( PluginToolsRequest request ) 041 throws ExtractionException, InvalidPluginDescriptorException; 042 043 /** 044 * <p> 045 * Sets the active extractors. 046 * </p> 047 * <p> 048 * Only the specified extractors will be used, all others will be skipped. 049 * </p> 050 * @param extractors The names of the active extractors. If this parameter is <code>null</code>, 051 * all the scanner's extractors are considered active. Set entries that are <code>null</code> or 052 * empty ("") will be ignored. 053 */ 054 void setActiveExtractors( Set<String> extractors ); 055 056}