io.micronaut.context.processor.AnnotationProcessor Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.context.processor;

import io.micronaut.inject.BeanDefinition;

import java.lang.annotation.Annotation;

/**
 * An annotation processor is an object that processes the presence if a given annotation.
 *
 * The {@link #process(BeanDefinition, Object)} method returns void since a processor is not able to mutate the
 * object itself or return an alternative instance, instead the design of a processor is to react to the rep
 *
 * @param  An annotation type
 * @param  A type
 * @author Graeme Rocher
 * @see ExecutableMethodProcessor
 * @since 1.0
 */
public interface AnnotationProcessor {

    /**
     * The process method will be called for every {@link io.micronaut.inject.ExecutableMethod} that is annotated with
     * the type parameter A.
     *
     * @param beanDefinition The bean definition
     * @param object         The object to be processed
     */
    void process(BeanDefinition beanDefinition, T object);
}