/*
* 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.apache.tuscany.sca.implementation.java.introspect;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import org.apache.tuscany.sca.implementation.java.IntrospectionException;
import org.apache.tuscany.sca.implementation.java.JavaImplementation;
import org.apache.tuscany.sca.implementation.java.JavaParameterImpl;
/**
* Implementations process class-level metadata, typically parsing annotations
* and updating the corresponding ComponentType
. A processor
* may, for example, create a Property which is responsible for injecting a
* complex type on a component implementation instance when it is instantiated.
*
Processors will receive callbacks as the implementation class is walked
* while evaluating an assembly. It is the responsibility of the parser to
* determine whether to perform an action during the callback.
*
* @version $Rev$ $Date$
*/
public interface JavaClassVisitor {
/**
* A callback received when the component implementation class is first
* loaded
*
* @param clazz the component implementation class
* @param type the incomplete component type associated with the
* implementation class
* @throws IntrospectionException if an error is encountered while processing
* metadata
*/
void visitClass(Class clazz, JavaImplementation type) throws IntrospectionException;
/**
* A callback received as the component implementation class hierarchy is
* evaluated
*
* @param clazz the superclass in the component implmentation's class
* hierarchy
* @param type the incomplete component type associated with the
* implementation class
* @throws IntrospectionException if an error is encountered while processing
* metadata
*/
void visitSuperClass(Class clazz, JavaImplementation type) throws IntrospectionException;
/**
* A callback received as the component implementation's public and
* protected methods are evaluated
*
* @param method the current public or protected method being evaluated
* @param type the incomplete component type associated with the
* implementation class
* @throws IntrospectionException if an error is encountered while processing
* metadata
*/
void visitMethod(Method method, JavaImplementation type) throws IntrospectionException;
/**
* A callback received as the component implementation's constructor used
* for instantiation by the runtime is evaluated. If an implementation
* contains more than one constructor, the constructor passed to the
* callback will be chosen according to the algorithm described in the SCA
* Java Client and Implementation Model Specification.
*
* @param constructor the constructor used for instantiating component
* implementation instances
* @param type the incomplete component type associated with the
* implementation class
* @throws IntrospectionException if an error is encountered while processing
* metadata
*/
void visitConstructor(Constructor constructor, JavaImplementation type) throws IntrospectionException;
/**
* @param parameter
* @param type
* @throws IntrospectionException
*/
void visitConstructorParameter(JavaParameterImpl parameter, JavaImplementation type) throws IntrospectionException;
/**
* A callback received as the component implementation's public and
* protected fields are evaluated
*
* @param field the current public or protected field being evaluated
* @param type the incomplete component type associated with the
* implementation class
* @throws IntrospectionException if an error is encountered while processing
* metadata
*/
void visitField(Field field, JavaImplementation type) throws IntrospectionException;
/**
* The final callback received when all other callbacks during evaluation of
* the component implementation have been issued
*
* @param clazz the component implementation class
* @param type the incomplete component type associated with the
* implementation class
* @throws IntrospectionException if an error is encountered while processing
* metadata
*/
void visitEnd(Class clazz, JavaImplementation type) throws IntrospectionException;
}