1 package org.apache.maven.tools.plugin.extractor.annotations.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.plugins.annotations.Component;
23 import org.apache.maven.plugins.annotations.Execute;
24 import org.apache.maven.plugins.annotations.Mojo;
25 import org.apache.maven.plugins.annotations.Parameter;
26 import org.apache.maven.tools.plugin.extractor.ExtractionException;
27
28 import java.util.Arrays;
29 import java.util.List;
30 import java.util.Map;
31
32 /**
33 * @author Olivier Lamy
34 * @since 3.0
35 */
36 public interface MojoAnnotationsScanner
37 {
38 String ROLE = MojoAnnotationsScanner.class.getName();
39
40 List<String> CLASS_LEVEL_ANNOTATIONS = Arrays.asList( Mojo.class.getName(), Execute.class.getName() );
41
42 List<String> FIELD_LEVEL_ANNOTATIONS = Arrays.asList( Parameter.class.getName(), Component.class.getName() );
43
44 /**
45 * Scan classes for mojo annotations.
46 *
47 * @param request
48 * @return map of mojo-annotated classes keyed by full class name
49 * @throws ExtractionException
50 */
51 Map<String, MojoAnnotatedClass> scan( MojoAnnotationsScannerRequest request )
52 throws ExtractionException;
53 }