View Javadoc

1   package org.apache.maven.tools.plugin.scanner;
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.PluginDescriptor;
24  import org.apache.maven.project.MavenProject;
25  import org.apache.maven.tools.plugin.extractor.ExtractionException;
26  
27  import java.util.Set;
28  
29  /**
30   * @author jdcasey
31   */
32  public interface MojoScanner
33  {
34      String ROLE = MojoScanner.class.getName();
35  
36      void populatePluginDescriptor( MavenProject project, PluginDescriptor pluginDescriptor )
37          throws ExtractionException, InvalidPluginDescriptorException;
38  
39  
40      /**
41       * Sets the active extractors.
42       * <p/>
43       * Only the specified extractors will be used, all others will be skipped.
44       *
45       * @param extractors The names of the sctive extractors. If this parameter is <code>null</code>,
46       *                   all the scanner's extractors are considered active. Set entries that are
47       *                   <code>null</code> or empty ("") will be ignored.
48       */
49      void setActiveExtractors( Set/* <String> */extractors );
50  
51  }