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

src/share/classes/com/sun/javadoc/AnnotationDesc.java@2eb010b6cb22 (annotated)

src/share/classes/com/sun/javadoc/AnnotationDesc.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 2227

998b10c43157

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2003, 2013, 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.javadoc;
aoqi@0	27
aoqi@0	28
aoqi@0	29	/**
aoqi@0	30	* Represents an annotation.
aoqi@0	31	* An annotation associates a value with each element of an annotation type.
aoqi@0	32	*
aoqi@0	33	* @author Scott Seligman
aoqi@0	34	* @since 1.5
aoqi@0	35	*/
aoqi@0	36	public interface AnnotationDesc {
aoqi@0	37
aoqi@0	38	/**
aoqi@0	39	* Returns the annotation type of this annotation.
aoqi@0	40	*
aoqi@0	41	* @return the annotation type of this annotation.
aoqi@0	42	*/
aoqi@0	43	AnnotationTypeDoc annotationType();
aoqi@0	44
aoqi@0	45	/**
aoqi@0	46	* Returns this annotation's elements and their values.
aoqi@0	47	* Only those explicitly present in the annotation are
aoqi@0	48	* included, not those assuming their default values.
aoqi@0	49	* Returns an empty array if there are none.
aoqi@0	50	*
aoqi@0	51	* @return this annotation's elements and their values.
aoqi@0	52	*/
aoqi@0	53	ElementValuePair[] elementValues();
aoqi@0	54
aoqi@0	55	/**
aoqi@0	56	* Check for the synthesized bit on the annotation.
aoqi@0	57	*
aoqi@0	58	* @return true if the annotation is synthesized.
aoqi@0	59	*/
aoqi@0	60	boolean isSynthesized();
aoqi@0	61
aoqi@0	62	/**
aoqi@0	63	* Represents an association between an annotation type element
aoqi@0	64	* and one of its values.
aoqi@0	65	*
aoqi@0	66	* @author Scott Seligman
aoqi@0	67	* @since 1.5
aoqi@0	68	*/
aoqi@0	69	public interface ElementValuePair {
aoqi@0	70
aoqi@0	71	/**
aoqi@0	72	* Returns the annotation type element.
aoqi@0	73	*
aoqi@0	74	* @return the annotation type element.
aoqi@0	75	*/
aoqi@0	76	AnnotationTypeElementDoc element();
aoqi@0	77
aoqi@0	78	/**
aoqi@0	79	* Returns the value associated with the annotation type element.
aoqi@0	80	*
aoqi@0	81	* @return the value associated with the annotation type element.
aoqi@0	82	*/
aoqi@0	83	AnnotationValue value();
aoqi@0	84	}
aoqi@0	85	}