jdk8-mips64-public/langtools: src/share/classes/javax/lang/model/element/PackageElement.java@c75be5bc5283

     1 /*

     2  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package javax.lang.model.element;

    28 import java.util.List;

    30 /**

    31  * Represents a package program element.  Provides access to information

    32  * about the package and its members.

    33  *

    34  * @author Joseph D. Darcy

    35  * @author Scott Seligman

    36  * @author Peter von der Ah&eacute;

    37  * @see javax.lang.model.util.Elements#getPackageOf

    38  * @since 1.6

    39  */

    40 public interface PackageElement extends Element, QualifiedNameable {

    42     /**

    43      * Returns the fully qualified name of this package.

    44      * This is also known as the package's <i>canonical</i> name.

    45      *

    46      * @return the fully qualified name of this package, or an

    47      * empty name if this is an unnamed package

    48      * @jls 6.7 Fully Qualified Names and Canonical Names

    49      */

    50     Name getQualifiedName();

    52     /**

    53      * Returns the simple name of this package.  For an unnamed

    54      * package, an empty name is returned.

    55      *

    56      * @return the simple name of this package or an empty name if

    57      * this is an unnamed package

    58      */

    59     @Override

    60     Name getSimpleName();

    62     /**

    63      * Returns the {@linkplain NestingKind#TOP_LEVEL top-level}

    64      * classes and interfaces within this package.  Note that

    65      * subpackages are <em>not</em> considered to be enclosed by a

    66      * package.

    67      *

    68      * @return the top-level classes and interfaces within this

    69      * package

    70      */

    71     @Override

    72     List<? extends Element> getEnclosedElements();

    74     /**

    75      * Returns {@code true} is this is an unnamed package and {@code

    76      * false} otherwise.

    77      *

    78      * @return {@code true} is this is an unnamed package and {@code

    79      * false} otherwise

    80      * @jls 7.4.2 Unnamed Packages

    81      */

    82     boolean isUnnamed();

    84     /**

    85      * Returns {@code null} since a package is not enclosed by another

    86      * element.

    87      *

    88      * @return {@code null}

    89      */

    90     @Override

    91     Element getEnclosingElement();

    92 }

Mercurial > jdk8-mips64-public > langtools / file revision