diff -r 024ed9c9ed13 -r 83c19f00452c langtools/src/jdk.javadoc/share/classes/com/sun/javadoc/ProgramElementDoc.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/langtools/src/jdk.javadoc/share/classes/com/sun/javadoc/ProgramElementDoc.java Sun Aug 17 15:52:32 2014 +0100 @@ -0,0 +1,141 @@ +/* + * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package com.sun.javadoc; + +/** + * Represents a java program element: class, interface, field, + * constructor, or method. + * This is an abstract class dealing with information common to + * these elements. + * + * @see MemberDoc + * @see ClassDoc + * + * @author Robert Field + */ +public interface ProgramElementDoc extends Doc { + + /** + * Get the containing class or interface of this program element. + * + * @return a ClassDoc for this element's containing class or interface. + * If this is a top-level class or interface, return null. + */ + ClassDoc containingClass(); + + /** + * Get the package that this program element is contained in. + * + * @return a PackageDoc for this element containing package. + * If in the unnamed package, this PackageDoc will have the + * name "". + */ + PackageDoc containingPackage(); + + /** + * Get the fully qualified name of this program element. + * For example, for the class {@code java.util.Hashtable}, + * return "java.util.Hashtable". + *

+ * For the method {@code bar()} in class {@code Foo} + * in the unnamed package, return "Foo.bar". + * + * @return the qualified name of the program element as a String. + */ + String qualifiedName(); + + /** + * Get the modifier specifier integer. + * + * @see java.lang.reflect.Modifier + * + * @return Get the modifier specifier integer. + */ + int modifierSpecifier(); + + /** + * Get modifiers string. + * For example, for: + *

+     *   public abstract int foo() { ... }
+     * 
+ * return "public abstract". + * Annotations are not included. + * + * @return "public abstract". + */ + String modifiers(); + + /** + * Get the annotations of this program element. + * Return an empty array if there are none. + * + * @return the annotations of this program element. + * @since 1.5 + */ + AnnotationDesc[] annotations(); + + /** + * Return true if this program element is public. + * + * @return true if this program element is public. + */ + boolean isPublic(); + + /** + * Return true if this program element is protected. + * + * @return true if this program element is protected. + */ + boolean isProtected(); + + /** + * Return true if this program element is private. + * + * @return true if this program element is private. + */ + boolean isPrivate(); + + /** + * Return true if this program element is package private. + * + * @return true if this program element is package private. + */ + boolean isPackagePrivate(); + /** + * Return true if this program element is static. + * + * @return true if this program element is static. + */ + boolean isStatic(); + + /** + * Return true if this program element is final. + * + * @return true if this program element is final. + */ + boolean isFinal(); +}