aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.model.annotation;
aoqi@0: 
aoqi@0: import java.lang.annotation.Annotation;
aoqi@0: import java.lang.reflect.Field;
aoqi@0: import java.lang.reflect.Method;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.Nullable;
aoqi@0: import com.sun.xml.internal.bind.v2.model.core.ErrorHandler;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Reads annotations for the given property.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This is the lowest abstraction that encapsulates the difference
aoqi@0:  * between reading inline annotations and external binding files.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Because the former operates on a {@link Field} and {@link Method}
aoqi@0:  * while the latter operates on a "property", the methods defined
aoqi@0:  * on this interface takes both, and the callee gets to choose which
aoqi@0:  * to use.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Most of the get method takes {@link Locatable}, which points to
aoqi@0:  * the place/context in which the annotation is read. The returned
aoqi@0:  * annotation also implements {@link Locatable} (so that it can
aoqi@0:  * point to the place where the annotation is placed), and its
aoqi@0:  * {@link Locatable#getUpstream()} will return the given
aoqi@0:  * {@link Locatable}.
aoqi@0:  *
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Errors found during reading annotations are reported through the error handler.
aoqi@0:  * A valid {@link ErrorHandler} must be registered before the {@link AnnotationReader}
aoqi@0:  * is used.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi (kk@kohsuke.org)
aoqi@0:  */
aoqi@0: public interface AnnotationReader<T,C,F,M> {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Sets the error handler that receives errors found
aoqi@0:      * during reading annotations.
aoqi@0:      *
aoqi@0:      * @param errorHandler
aoqi@0:      *      must not be null.
aoqi@0:      */
aoqi@0:     void setErrorHandler(ErrorHandler errorHandler);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Reads an annotation on a property that consists of a field.
aoqi@0:      */
aoqi@0:     <A extends Annotation> A getFieldAnnotation(Class<A> annotation,
aoqi@0:                                                 F field, Locatable srcpos);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Checks if the given field has an annotation.
aoqi@0:      */
aoqi@0:     boolean hasFieldAnnotation(Class<? extends Annotation> annotationType, F field);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Checks if a class has the annotation.
aoqi@0:      */
aoqi@0:     boolean hasClassAnnotation(C clazz, Class<? extends Annotation> annotationType);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets all the annotations on a field.
aoqi@0:      */
aoqi@0:     Annotation[] getAllFieldAnnotations(F field, Locatable srcPos);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Reads an annotation on a property that consists of a getter and a setter.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     <A extends Annotation> A getMethodAnnotation(Class<A> annotation,
aoqi@0:                                                  M getter, M setter, Locatable srcpos);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Checks if the given method has an annotation.
aoqi@0:      */
aoqi@0:     boolean hasMethodAnnotation(Class<? extends Annotation> annotation, String propertyName, M getter, M setter, Locatable srcPos);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets all the annotations on a method.
aoqi@0:      *
aoqi@0:      * @param srcPos
aoqi@0:      *      the location from which this annotation is read.
aoqi@0:      */
aoqi@0:     Annotation[] getAllMethodAnnotations(M method, Locatable srcPos);
aoqi@0: 
aoqi@0:     // TODO: we do need this to read certain annotations,
aoqi@0:     // but that shows inconsistency wrt the spec. consult the spec team about the abstraction.
aoqi@0:     <A extends Annotation> A getMethodAnnotation(Class<A> annotation, M method, Locatable srcpos );
aoqi@0: 
aoqi@0:     boolean hasMethodAnnotation(Class<? extends Annotation> annotation, M method );
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Reads an annotation on a parameter of the method.
aoqi@0:      *
aoqi@0:      * @return null
aoqi@0:      *      if the annotation was not found.
aoqi@0:      */
aoqi@0:     @Nullable
aoqi@0:     <A extends Annotation> A getMethodParameterAnnotation(
aoqi@0:             Class<A> annotation, M method, int paramIndex, Locatable srcPos );
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Reads an annotation on a class.
aoqi@0:      */
aoqi@0:     @Nullable
aoqi@0:     <A extends Annotation> A getClassAnnotation(Class<A> annotation, C clazz, Locatable srcpos) ;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Reads an annotation on the package that the given class belongs to.
aoqi@0:      */
aoqi@0:     @Nullable
aoqi@0:     <A extends Annotation> A getPackageAnnotation(Class<A> annotation, C clazz, Locatable srcpos);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Reads a value of an annotation that returns a Class object.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * Depending on the underlying reflection library, you can't always
aoqi@0:      * obtain the {@link Class} object directly (see the Annotation Processing MirrorTypeException
aoqi@0:      * for example), so use this method to avoid that.
aoqi@0:      *
aoqi@0:      * @param name
aoqi@0:      *      The name of the annotation parameter to be read.
aoqi@0:      */
aoqi@0:     T getClassValue( Annotation a, String name );
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Similar to {@link #getClassValue(Annotation, String)} method but
aoqi@0:      * obtains an array parameter.
aoqi@0:      */
aoqi@0:     T[] getClassArrayValue( Annotation a, String name );
aoqi@0: }