/*

 * Copyright (c) 2005, 2017, 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 javax.lang.model.element;

import java.util.List;

/**

 * Represents a package program element.  Provides access to information

 * about the package and its members.

 *

 * @author Joseph D. Darcy

 * @author Scott Seligman

 * @author Peter von der Ahé

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

 * @since 1.6

 */

public interface PackageElement extends Element, QualifiedNameable {

    /**

     * Returns the fully qualified name of this package.

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

     * For an {@linkplain #isUnnamed() unnamed package}, an empty name is returned.

     *

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

     * empty name if this is an unnamed package

     * @jls 6.7 Fully Qualified Names and Canonical Names

     */

    Name getQualifiedName();

    /**

     * Returns the simple name of this package.  For an {@linkplain

     * #isUnnamed() unnamed package}, an empty name is returned.

     *

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

     * this is an unnamed package

     */

    @Override

    Name getSimpleName();

    /**

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

     * classes and interfaces within this package.  Note that

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

     * package.

     *

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

     * package

     */

    @Override

    List<? extends Element> getEnclosedElements();

    /**

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

     * false} otherwise.

     *

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

     * false} otherwise

     * @jls 7.4.2 Unnamed Packages

     */

    boolean isUnnamed();

    /**

     * Returns the enclosing module if such a module exists; otherwise

     * returns {@code null}.

     *

     * One situation where a module does not exist for a package is if

     * the environment does not include modules, such as an annotation

     * processing environment configured for a {@linkplain

     * javax.annotation.processing.ProcessingEnvironment#getSourceVersion

     * source version} without modules.

     *

     * @return the enclosing module or {@code null} if no such module exists

     */

    @Override

    Element getEnclosingElement();

}