src/share/classes/javax/lang/model/element/PackageElement.java

Wed, 27 Apr 2016 01:34:52 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2005, 2012, 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 javax.lang.model.element;
aoqi@0 27
aoqi@0 28 import java.util.List;
aoqi@0 29
aoqi@0 30 /**
aoqi@0 31 * Represents a package program element. Provides access to information
aoqi@0 32 * about the package and its members.
aoqi@0 33 *
aoqi@0 34 * @author Joseph D. Darcy
aoqi@0 35 * @author Scott Seligman
aoqi@0 36 * @author Peter von der Ahé
aoqi@0 37 * @see javax.lang.model.util.Elements#getPackageOf
aoqi@0 38 * @since 1.6
aoqi@0 39 */
aoqi@0 40 public interface PackageElement extends Element, QualifiedNameable {
aoqi@0 41
aoqi@0 42 /**
aoqi@0 43 * Returns the fully qualified name of this package.
aoqi@0 44 * This is also known as the package's <i>canonical</i> name.
aoqi@0 45 *
aoqi@0 46 * @return the fully qualified name of this package, or an
aoqi@0 47 * empty name if this is an unnamed package
aoqi@0 48 * @jls 6.7 Fully Qualified Names and Canonical Names
aoqi@0 49 */
aoqi@0 50 Name getQualifiedName();
aoqi@0 51
aoqi@0 52 /**
aoqi@0 53 * Returns the simple name of this package. For an unnamed
aoqi@0 54 * package, an empty name is returned.
aoqi@0 55 *
aoqi@0 56 * @return the simple name of this package or an empty name if
aoqi@0 57 * this is an unnamed package
aoqi@0 58 */
aoqi@0 59 @Override
aoqi@0 60 Name getSimpleName();
aoqi@0 61
aoqi@0 62 /**
aoqi@0 63 * Returns the {@linkplain NestingKind#TOP_LEVEL top-level}
aoqi@0 64 * classes and interfaces within this package. Note that
aoqi@0 65 * subpackages are <em>not</em> considered to be enclosed by a
aoqi@0 66 * package.
aoqi@0 67 *
aoqi@0 68 * @return the top-level classes and interfaces within this
aoqi@0 69 * package
aoqi@0 70 */
aoqi@0 71 @Override
aoqi@0 72 List<? extends Element> getEnclosedElements();
aoqi@0 73
aoqi@0 74 /**
aoqi@0 75 * Returns {@code true} is this is an unnamed package and {@code
aoqi@0 76 * false} otherwise.
aoqi@0 77 *
aoqi@0 78 * @return {@code true} is this is an unnamed package and {@code
aoqi@0 79 * false} otherwise
aoqi@0 80 * @jls 7.4.2 Unnamed Packages
aoqi@0 81 */
aoqi@0 82 boolean isUnnamed();
aoqi@0 83
aoqi@0 84 /**
aoqi@0 85 * Returns {@code null} since a package is not enclosed by another
aoqi@0 86 * element.
aoqi@0 87 *
aoqi@0 88 * @return {@code null}
aoqi@0 89 */
aoqi@0 90 @Override
aoqi@0 91 Element getEnclosingElement();
aoqi@0 92 }

mercurial