1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/javax/lang/model/element/PackageElement.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,92 @@
1.4 +/*
1.5 + * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package javax.lang.model.element;
1.30 +
1.31 +import java.util.List;
1.32 +
1.33 +/**
1.34 + * Represents a package program element. Provides access to information
1.35 + * about the package and its members.
1.36 + *
1.37 + * @author Joseph D. Darcy
1.38 + * @author Scott Seligman
1.39 + * @author Peter von der Ahé
1.40 + * @see javax.lang.model.util.Elements#getPackageOf
1.41 + * @since 1.6
1.42 + */
1.43 +public interface PackageElement extends Element, QualifiedNameable {
1.44 +
1.45 + /**
1.46 + * Returns the fully qualified name of this package.
1.47 + * This is also known as the package's <i>canonical</i> name.
1.48 + *
1.49 + * @return the fully qualified name of this package, or an
1.50 + * empty name if this is an unnamed package
1.51 + * @jls 6.7 Fully Qualified Names and Canonical Names
1.52 + */
1.53 + Name getQualifiedName();
1.54 +
1.55 + /**
1.56 + * Returns the simple name of this package. For an unnamed
1.57 + * package, an empty name is returned.
1.58 + *
1.59 + * @return the simple name of this package or an empty name if
1.60 + * this is an unnamed package
1.61 + */
1.62 + @Override
1.63 + Name getSimpleName();
1.64 +
1.65 + /**
1.66 + * Returns the {@linkplain NestingKind#TOP_LEVEL top-level}
1.67 + * classes and interfaces within this package. Note that
1.68 + * subpackages are <em>not</em> considered to be enclosed by a
1.69 + * package.
1.70 + *
1.71 + * @return the top-level classes and interfaces within this
1.72 + * package
1.73 + */
1.74 + @Override
1.75 + List<? extends Element> getEnclosedElements();
1.76 +
1.77 + /**
1.78 + * Returns {@code true} is this is an unnamed package and {@code
1.79 + * false} otherwise.
1.80 + *
1.81 + * @return {@code true} is this is an unnamed package and {@code
1.82 + * false} otherwise
1.83 + * @jls 7.4.2 Unnamed Packages
1.84 + */
1.85 + boolean isUnnamed();
1.86 +
1.87 + /**
1.88 + * Returns {@code null} since a package is not enclosed by another
1.89 + * element.
1.90 + *
1.91 + * @return {@code null}
1.92 + */
1.93 + @Override
1.94 + Element getEnclosingElement();
1.95 +}
