Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/javadoc/AnnotationDesc.java@f91144b7da75 (annotated)
src/share/classes/com/sun/javadoc/AnnotationDesc.java
Mon, 04 Feb 2013 18:08:53 -0500
- author
- dholmes
- date
- Mon, 04 Feb 2013 18:08:53 -0500
- changeset 1570
- f91144b7da75
- parent 1477
- 8c0c63a6e3b7
- child 2227
- 998b10c43157
- permissions
- -rw-r--r--
Merge
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | |
| duke@1 | 29 | /** |
| duke@1 | 30 | * Represents an annotation. |
| duke@1 | 31 | * An annotation associates a value with each element of an annotation type. |
| duke@1 | 32 | * |
| duke@1 | 33 | * @author Scott Seligman |
| duke@1 | 34 | * @since 1.5 |
| duke@1 | 35 | */ |
| duke@1 | 36 | public interface AnnotationDesc { |
| duke@1 | 37 | |
| duke@1 | 38 | /** |
| duke@1 | 39 | * Returns the annotation type of this annotation. |
| duke@1 | 40 | * |
| duke@1 | 41 | * @return the annotation type of this annotation. |
| duke@1 | 42 | */ |
| duke@1 | 43 | AnnotationTypeDoc annotationType(); |
| duke@1 | 44 | |
| duke@1 | 45 | /** |
| duke@1 | 46 | * Returns this annotation's elements and their values. |
| duke@1 | 47 | * Only those explicitly present in the annotation are |
| duke@1 | 48 | * included, not those assuming their default values. |
| duke@1 | 49 | * Returns an empty array if there are none. |
| duke@1 | 50 | * |
| duke@1 | 51 | * @return this annotation's elements and their values. |
| duke@1 | 52 | */ |
| duke@1 | 53 | ElementValuePair[] elementValues(); |
| duke@1 | 54 | |
| bpatel@1477 | 55 | /** |
| bpatel@1477 | 56 | * Check for the synthesized bit on the annotation. |
| bpatel@1477 | 57 | * |
| bpatel@1477 | 58 | * @return true if the annotation is synthesized. |
| bpatel@1477 | 59 | */ |
| bpatel@1477 | 60 | boolean isSynthesized(); |
| duke@1 | 61 | |
| duke@1 | 62 | /** |
| duke@1 | 63 | * Represents an association between an annotation type element |
| duke@1 | 64 | * and one of its values. |
| duke@1 | 65 | * |
| duke@1 | 66 | * @author Scott Seligman |
| duke@1 | 67 | * @since 1.5 |
| duke@1 | 68 | */ |
| duke@1 | 69 | public interface ElementValuePair { |
| duke@1 | 70 | |
| duke@1 | 71 | /** |
| duke@1 | 72 | * Returns the annotation type element. |
| duke@1 | 73 | * |
| duke@1 | 74 | * @return the annotation type element. |
| duke@1 | 75 | */ |
| duke@1 | 76 | AnnotationTypeElementDoc element(); |
| duke@1 | 77 | |
| duke@1 | 78 | /** |
| duke@1 | 79 | * Returns the value associated with the annotation type element. |
| duke@1 | 80 | * |
| duke@1 | 81 | * @return the value associated with the annotation type element. |
| duke@1 | 82 | */ |
| duke@1 | 83 | AnnotationValue value(); |
| duke@1 | 84 | } |
| duke@1 | 85 | } |
