Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/javadoc/ProgramElementDoc.java@998b10c43157 (annotated)
src/share/classes/com/sun/javadoc/ProgramElementDoc.java
Tue, 24 Dec 2013 09:17:37 -0800
- author
- ksrini
- date
- Tue, 24 Dec 2013 09:17:37 -0800
- changeset 2227
- 998b10c43157
- parent 554
- 9d9f26857129
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 1998, 2006, 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 | * Represents a java program element: class, interface, field, |
| duke@1 | 30 | * constructor, or method. |
| duke@1 | 31 | * This is an abstract class dealing with information common to |
| duke@1 | 32 | * these elements. |
| duke@1 | 33 | * |
| duke@1 | 34 | * @see MemberDoc |
| duke@1 | 35 | * @see ClassDoc |
| duke@1 | 36 | * |
| duke@1 | 37 | * @author Robert Field |
| duke@1 | 38 | */ |
| duke@1 | 39 | public interface ProgramElementDoc extends Doc { |
| duke@1 | 40 | |
| duke@1 | 41 | /** |
| duke@1 | 42 | * Get the containing class or interface of this program element. |
| duke@1 | 43 | * |
| duke@1 | 44 | * @return a ClassDoc for this element's containing class or interface. |
| duke@1 | 45 | * If this is a top-level class or interface, return null. |
| duke@1 | 46 | */ |
| duke@1 | 47 | ClassDoc containingClass(); |
| duke@1 | 48 | |
| duke@1 | 49 | /** |
| duke@1 | 50 | * Get the package that this program element is contained in. |
| duke@1 | 51 | * |
| duke@1 | 52 | * @return a PackageDoc for this element containing package. |
| duke@1 | 53 | * If in the unnamed package, this PackageDoc will have the |
| duke@1 | 54 | * name "". |
| duke@1 | 55 | */ |
| duke@1 | 56 | PackageDoc containingPackage(); |
| duke@1 | 57 | |
| duke@1 | 58 | /** |
| duke@1 | 59 | * Get the fully qualified name of this program element. |
| duke@1 | 60 | * For example, for the class <code>java.util.Hashtable</code>, |
| duke@1 | 61 | * return "java.util.Hashtable". |
| duke@1 | 62 | * <p> |
| duke@1 | 63 | * For the method <code>bar()</code> in class <code>Foo</code> |
| duke@1 | 64 | * in the unnamed package, return "Foo.bar". |
| duke@1 | 65 | * |
| duke@1 | 66 | * @return the qualified name of the program element as a String. |
| duke@1 | 67 | */ |
| duke@1 | 68 | String qualifiedName(); |
| duke@1 | 69 | |
| duke@1 | 70 | /** |
| duke@1 | 71 | * Get the modifier specifier integer. |
| duke@1 | 72 | * |
| duke@1 | 73 | * @see java.lang.reflect.Modifier |
| duke@1 | 74 | */ |
| duke@1 | 75 | int modifierSpecifier(); |
| duke@1 | 76 | |
| duke@1 | 77 | /** |
| duke@1 | 78 | * Get modifiers string. |
| duke@1 | 79 | * For example, for: |
| duke@1 | 80 | * <pre> |
| duke@1 | 81 | * public abstract int foo() { ... } |
| duke@1 | 82 | * </pre> |
| duke@1 | 83 | * return "public abstract". |
| duke@1 | 84 | * Annotations are not included. |
| duke@1 | 85 | */ |
| duke@1 | 86 | String modifiers(); |
| duke@1 | 87 | |
| duke@1 | 88 | /** |
| duke@1 | 89 | * Get the annotations of this program element. |
| duke@1 | 90 | * Return an empty array if there are none. |
| duke@1 | 91 | * |
| duke@1 | 92 | * @return the annotations of this program element. |
| duke@1 | 93 | * @since 1.5 |
| duke@1 | 94 | */ |
| duke@1 | 95 | AnnotationDesc[] annotations(); |
| duke@1 | 96 | |
| duke@1 | 97 | /** |
| duke@1 | 98 | * Return true if this program element is public. |
| duke@1 | 99 | */ |
| duke@1 | 100 | boolean isPublic(); |
| duke@1 | 101 | |
| duke@1 | 102 | /** |
| duke@1 | 103 | * Return true if this program element is protected. |
| duke@1 | 104 | */ |
| duke@1 | 105 | boolean isProtected(); |
| duke@1 | 106 | |
| duke@1 | 107 | /** |
| duke@1 | 108 | * Return true if this program element is private. |
| duke@1 | 109 | */ |
| duke@1 | 110 | boolean isPrivate(); |
| duke@1 | 111 | |
| duke@1 | 112 | /** |
| duke@1 | 113 | * Return true if this program element is package private. |
| duke@1 | 114 | */ |
| duke@1 | 115 | boolean isPackagePrivate(); |
| duke@1 | 116 | /** |
| duke@1 | 117 | * Return true if this program element is static. |
| duke@1 | 118 | */ |
| duke@1 | 119 | boolean isStatic(); |
| duke@1 | 120 | |
| duke@1 | 121 | /** |
| duke@1 | 122 | * Return true if this program element is final. |
| duke@1 | 123 | */ |
| duke@1 | 124 | boolean isFinal(); |
| duke@1 | 125 | } |
