org.fabric3.introspection.java.AnnotationProcessor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-introspection-spi Show documentation
Show all versions of fabric3-introspection-spi Show documentation
Fabric3 SPIs for component introspection.
The newest version!
/*
* Fabric3
* Copyright ? 2008 Metaform Systems Limited
*
* This proprietary software may be used only connection with the Fabric3 license
* (the ?License?), a copy of which is included in the software or may be
* obtained at: http://www.metaformsystems.com/licenses/license.html.
* Software distributed under the License is distributed on an ?as is? basis,
* without warranties or conditions of any kind. See the License for the
* specific language governing permissions and limitations of use of the software.
* This software is distributed in conjunction with other software licensed under
* different terms. See the separate licenses for those programs included in the
* distribution for the permitted and restricted uses of such software.
*
* --- Original Apache License ---
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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
*
* http://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 org.fabric3.introspection.java;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import org.fabric3.introspection.IntrospectionContext;
import org.fabric3.scdl.Implementation;
import org.fabric3.scdl.InjectingComponentType;
/**
* Interface for processors that handle annotations attached to Java declarations.
*
* @version $Rev: 5481 $ $Date: 2008-09-26 02:36:30 -0700 (Fri, 26 Sep 2008) $
* @param the type of annotation this processor handles
*/
public interface AnnotationProcessor> {
/**
* Returns the type of annotation this processor handles.
*
* @return the type of annotation this processor handles
*/
Class getType();
/**
* Visit an annotation on a package declaration. If errors or warnings are encountered, they will be collated in the IntrospectionContext.
*
* @param annotation the annotation
* @param javaPackage the package
* @param implementation the implementation being introspected
* @param context the current introspection context
*/
void visitPackage(A annotation, Package javaPackage, I implementation, IntrospectionContext context);
/**
* Visit an annotation on a class or interface declaration. If errors or warnings are encountered, they will be collated in the
* IntrospectionContext.
*
* @param annotation the annotation
* @param type the class or interface
* @param implementation the implementation being introspected
* @param context the current introspection context
*/
void visitType(A annotation, Class type, I implementation, IntrospectionContext context);
/**
* Visit an annotation on a field declaration. If errors or warnings are encountered, they will be collated in the IntrospectionContext.
*
* @param annotation the annotation
* @param field the field
* @param implementation the implementation being introspected
* @param context the current introspection context
*/
void visitField(A annotation, Field field, I implementation, IntrospectionContext context);
/**
* Visit an annotation on a method declaration. If errors or warnings are encountered, they will be collated in the IntrospectionContext.
*
* @param annotation the annotation
* @param method the method declaration
* @param implementation the implementation being introspected
* @param context the current introspection context
*/
void visitMethod(A annotation, Method method, I implementation, IntrospectionContext context);
/**
* Visit an annotation on a method parameter declaration. If errors or warnings are encountered, they will be collated in the
* IntrospectionContext.
*
* @param annotation the annotation
* @param method the method declaration
* @param index the index of the method parameter
* @param implementation the implementation being introspected
* @param context the current introspection context
*/
void visitMethodParameter(A annotation, Method method, int index, I implementation, IntrospectionContext context);
/**
* Visit an annotation on a constructor declaration. If errors or warnings are encountered, they will be collated in the IntrospectionContext.
*
* @param annotation the annotation
* @param constructor the constructor
* @param implementation the implementation being introspected
* @param context the current introspection context
*/
void visitConstructor(A annotation, Constructor constructor, I implementation, IntrospectionContext context);
/**
* Visit an annotation on a constructor parameter declaration. If errors or warnings are encountered, they will be collated in the
* IntrospectionContext.
*
* @param annotation the annotation
* @param constructor the constructor
* @param index the index of the constructor parameter
* @param implementation the implementation being introspected
* @param context the current introspection context
*/
void visitConstructorParameter(A annotation, Constructor constructor, int index, I implementation, IntrospectionContext context);
}