• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/annotation/AnnotationReader.java@e530533619ec (annotated)

src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/annotation/AnnotationReader.java

Thu, 12 Oct 2017 19:44:07 +0800

author

aoqi

date

Thu, 12 Oct 2017 19:44:07 +0800

changeset 760

e530533619ec

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.bind.v2.model.annotation;
aoqi@0	27
aoqi@0	28	import java.lang.annotation.Annotation;
aoqi@0	29	import java.lang.reflect.Field;
aoqi@0	30	import java.lang.reflect.Method;
aoqi@0	31
aoqi@0	32	import com.sun.istack.internal.Nullable;
aoqi@0	33	import com.sun.xml.internal.bind.v2.model.core.ErrorHandler;
aoqi@0	34
aoqi@0	35	/**
aoqi@0	36	* Reads annotations for the given property.
aoqi@0	37	*
aoqi@0	38	* <p>
aoqi@0	39	* This is the lowest abstraction that encapsulates the difference
aoqi@0	40	* between reading inline annotations and external binding files.
aoqi@0	41	*
aoqi@0	42	* <p>
aoqi@0	43	* Because the former operates on a {@link Field} and {@link Method}
aoqi@0	44	* while the latter operates on a "property", the methods defined
aoqi@0	45	* on this interface takes both, and the callee gets to choose which
aoqi@0	46	* to use.
aoqi@0	47	*
aoqi@0	48	* <p>
aoqi@0	49	* Most of the get method takes {@link Locatable}, which points to
aoqi@0	50	* the place/context in which the annotation is read. The returned
aoqi@0	51	* annotation also implements {@link Locatable} (so that it can
aoqi@0	52	* point to the place where the annotation is placed), and its
aoqi@0	53	* {@link Locatable#getUpstream()} will return the given
aoqi@0	54	* {@link Locatable}.
aoqi@0	55	*
aoqi@0	56	*
aoqi@0	57	* <p>
aoqi@0	58	* Errors found during reading annotations are reported through the error handler.
aoqi@0	59	* A valid {@link ErrorHandler} must be registered before the {@link AnnotationReader}
aoqi@0	60	* is used.
aoqi@0	61	*
aoqi@0	62	* @author Kohsuke Kawaguchi (kk@kohsuke.org)
aoqi@0	63	*/
aoqi@0	64	public interface AnnotationReader<T,C,F,M> {
aoqi@0	65
aoqi@0	66	/**
aoqi@0	67	* Sets the error handler that receives errors found
aoqi@0	68	* during reading annotations.
aoqi@0	69	*
aoqi@0	70	* @param errorHandler
aoqi@0	71	* must not be null.
aoqi@0	72	*/
aoqi@0	73	void setErrorHandler(ErrorHandler errorHandler);
aoqi@0	74
aoqi@0	75	/**
aoqi@0	76	* Reads an annotation on a property that consists of a field.
aoqi@0	77	*/
aoqi@0	78	<A extends Annotation> A getFieldAnnotation(Class<A> annotation,
aoqi@0	79	F field, Locatable srcpos);
aoqi@0	80
aoqi@0	81	/**
aoqi@0	82	* Checks if the given field has an annotation.
aoqi@0	83	*/
aoqi@0	84	boolean hasFieldAnnotation(Class<? extends Annotation> annotationType, F field);
aoqi@0	85
aoqi@0	86	/**
aoqi@0	87	* Checks if a class has the annotation.
aoqi@0	88	*/
aoqi@0	89	boolean hasClassAnnotation(C clazz, Class<? extends Annotation> annotationType);
aoqi@0	90
aoqi@0	91	/**
aoqi@0	92	* Gets all the annotations on a field.
aoqi@0	93	*/
aoqi@0	94	Annotation[] getAllFieldAnnotations(F field, Locatable srcPos);
aoqi@0	95
aoqi@0	96	/**
aoqi@0	97	* Reads an annotation on a property that consists of a getter and a setter.
aoqi@0	98	*
aoqi@0	99	*/
aoqi@0	100	<A extends Annotation> A getMethodAnnotation(Class<A> annotation,
aoqi@0	101	M getter, M setter, Locatable srcpos);
aoqi@0	102
aoqi@0	103	/**
aoqi@0	104	* Checks if the given method has an annotation.
aoqi@0	105	*/
aoqi@0	106	boolean hasMethodAnnotation(Class<? extends Annotation> annotation, String propertyName, M getter, M setter, Locatable srcPos);
aoqi@0	107
aoqi@0	108	/**
aoqi@0	109	* Gets all the annotations on a method.
aoqi@0	110	*
aoqi@0	111	* @param srcPos
aoqi@0	112	* the location from which this annotation is read.
aoqi@0	113	*/
aoqi@0	114	Annotation[] getAllMethodAnnotations(M method, Locatable srcPos);
aoqi@0	115
aoqi@0	116	// TODO: we do need this to read certain annotations,
aoqi@0	117	// but that shows inconsistency wrt the spec. consult the spec team about the abstraction.
aoqi@0	118	<A extends Annotation> A getMethodAnnotation(Class<A> annotation, M method, Locatable srcpos );
aoqi@0	119
aoqi@0	120	boolean hasMethodAnnotation(Class<? extends Annotation> annotation, M method );
aoqi@0	121
aoqi@0	122	/**
aoqi@0	123	* Reads an annotation on a parameter of the method.
aoqi@0	124	*
aoqi@0	125	* @return null
aoqi@0	126	* if the annotation was not found.
aoqi@0	127	*/
aoqi@0	128	@Nullable
aoqi@0	129	<A extends Annotation> A getMethodParameterAnnotation(
aoqi@0	130	Class<A> annotation, M method, int paramIndex, Locatable srcPos );
aoqi@0	131
aoqi@0	132	/**
aoqi@0	133	* Reads an annotation on a class.
aoqi@0	134	*/
aoqi@0	135	@Nullable
aoqi@0	136	<A extends Annotation> A getClassAnnotation(Class<A> annotation, C clazz, Locatable srcpos) ;
aoqi@0	137
aoqi@0	138	/**
aoqi@0	139	* Reads an annotation on the package that the given class belongs to.
aoqi@0	140	*/
aoqi@0	141	@Nullable
aoqi@0	142	<A extends Annotation> A getPackageAnnotation(Class<A> annotation, C clazz, Locatable srcpos);
aoqi@0	143
aoqi@0	144	/**
aoqi@0	145	* Reads a value of an annotation that returns a Class object.
aoqi@0	146	*
aoqi@0	147	* <p>
aoqi@0	148	* Depending on the underlying reflection library, you can't always
aoqi@0	149	* obtain the {@link Class} object directly (see the Annotation Processing MirrorTypeException
aoqi@0	150	* for example), so use this method to avoid that.
aoqi@0	151	*
aoqi@0	152	* @param name
aoqi@0	153	* The name of the annotation parameter to be read.
aoqi@0	154	*/
aoqi@0	155	T getClassValue( Annotation a, String name );
aoqi@0	156
aoqi@0	157	/**
aoqi@0	158	* Similar to {@link #getClassValue(Annotation, String)} method but
aoqi@0	159	* obtains an array parameter.
aoqi@0	160	*/
aoqi@0	161	T[] getClassArrayValue( Annotation a, String name );
aoqi@0	162	}