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

Fri, 28 Jan 2011 16:54:18 -0800

author
darcy
date
Fri, 28 Jan 2011 16:54:18 -0800
changeset 849
7a75a1803c7a
parent 554
9d9f26857129
child 972
694ff82ca68e
permissions
-rw-r--r--

7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
Reviewed-by: jjg

     1 /*
     2  * Copyright (c) 2005, 2011, 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 /**
    29  * Represents a package program element.  Provides access to information
    30  * about the package and its members.
    31  *
    32  * @author Joseph D. Darcy
    33  * @author Scott Seligman
    34  * @author Peter von der Ahé
    35  * @see javax.lang.model.util.Elements#getPackageOf
    36  * @since 1.6
    37  */
    38 public interface PackageElement extends Element, QualifiedNameable {
    40     /**
    41      * Returns the fully qualified name of this package.
    42      * This is also known as the package's <i>canonical</i> name.
    43      *
    44      * @return the fully qualified name of this package, or an
    45      * empty name if this is an unnamed package
    46      * @jls3 6.7 Fully Qualified Names and Canonical Names
    47      */
    48     Name getQualifiedName();
    50     /**
    51      * Returns the simple name of this package.  For an unnamed
    52      * package, an empty name is returned
    53      *
    54      * @return the simple name of this package or an empty name if
    55      * this is an unnamed package
    56      */
    57     @Override
    58     Name getSimpleName();
    60     /**
    61      * Returns {@code true} is this is an unnamed package and {@code
    62      * false} otherwise.
    63      *
    64      * @return {@code true} is this is an unnamed package and {@code
    65      * false} otherwise
    66      * @jls3 7.4.2 Unnamed Packages
    67      */
    68     boolean isUnnamed();
    70     /**
    71      * Returns {@code null} since a package is not enclosed by another
    72      * element.
    73      *
    74      * @return {@code null}
    75      */
    76     @Override
    77     Element getEnclosingElement();
    78 }

mercurial