001package org.apache.maven.tools.plugin.extractor.annotations.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.plugins.annotations.Component;
023import org.apache.maven.plugins.annotations.Execute;
024import org.apache.maven.plugins.annotations.Mojo;
025import org.apache.maven.plugins.annotations.Parameter;
026import org.apache.maven.tools.plugin.extractor.ExtractionException;
027
028import java.util.Arrays;
029import java.util.List;
030import java.util.Map;
031
032/**
033 * @author Olivier Lamy
034 * @since 3.0
035 */
036public interface MojoAnnotationsScanner
037{
038    String ROLE = MojoAnnotationsScanner.class.getName();
039
040    List<String> CLASS_LEVEL_ANNOTATIONS = Arrays.asList( Mojo.class.getName(),
041                                                          Execute.class.getName(),
042                                                          Deprecated.class.getName() );
043
044    List<String> FIELD_LEVEL_ANNOTATIONS = Arrays.asList( Parameter.class.getName(),
045                                                          Component.class.getName(),
046                                                          Deprecated.class.getName() );
047
048    List<String> METHOD_LEVEL_ANNOTATIONS = Arrays.asList( Parameter.class.getName(),
049                                                           Deprecated.class.getName() );
050
051    /**
052     * Scan classes for mojo annotations.
053     * 
054     * @param request
055     * @return map of mojo-annotated classes keyed by full class name
056     * @throws ExtractionException
057     */
058    Map<String, MojoAnnotatedClass> scan( MojoAnnotationsScannerRequest request )
059        throws ExtractionException;
060}