/* * 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 module program element. Provides access to information * about the module and its members. * * @see javax.lang.model.util.Elements#getModuleOf * @since 9 * @spec JPMS */ // TODO: add @jls to module section public interface ModuleElement extends Element, QualifiedNameable { /** * Returns the fully qualified name of this module. * * @return the qualified name of this module, or an * empty name if this is an unnamed module */ @Override Name getQualifiedName(); /** * Returns the simple name of this module. For an unnamed * module, an empty name is returned. * * @return the simple name of this module or an empty name if * this is an unnamed module */ @Override Name getSimpleName(); /** * Returns the packages within this module. * @return the packages within this module */ @Override List getEnclosedElements(); /** * Returns {@code true} if this is an open module and {@code * false} otherwise. * * @return {@code true} if this is an open module and {@code * false} otherwise */ // TODO: add @jls to unnamed module section boolean isOpen(); /** * Returns {@code true} if this is an unnamed module and {@code * false} otherwise. * * @return {@code true} if this is an unnamed module and {@code * false} otherwise */ // TODO: add @jls to unnamed module section boolean isUnnamed(); /** * Returns {@code null} since a module is not enclosed by another * element. * * @return {@code null} */ @Override Element getEnclosingElement(); /** * Returns the directives contained in the declaration of this module. * @return the directives in the declaration of this module */ List getDirectives(); /** * The {@code kind} of a directive. * *

Note that it is possible additional directive kinds will be added * to accommodate new, currently unknown, language structures added to * future versions of the Java™ programming language. * * @since 9 * @spec JPMS */ enum DirectiveKind { /** A "requires (static|transitive)* module-name" directive. */ REQUIRES, /** An "exports package-name [to module-name-list]" directive. */ EXPORTS, /** An "opens package-name [to module-name-list]" directive. */ OPENS, /** A "uses service-name" directive. */ USES, /** A "provides service-name with implementation-name" directive. */ PROVIDES }; /** * Represents a "module statement" within the declaration of this module. * * @since 9 * @spec JPMS * */ // TODO: add jls to Module Statement interface Directive { /** * Returns the {@code kind} of this directive. * * @return the kind of this directive */ DirectiveKind getKind(); } /** * A dependency of a module. * @since 9 * @spec JPMS */ interface RequiresDirective extends Directive { /** * Returns whether or not this is a static dependency. * @return whether or not this is a static dependency */ boolean isStatic(); /** * Returns whether or not this is a transitive dependency. * @return whether or not this is a transitive dependency */ boolean isTransitive(); /** * Returns the module that is required * @return the module that is required */ ModuleElement getDependency(); } /** * An exported package of a module. * @since 9 * @spec JPMS */ interface ExportsDirective extends Directive { /** * Returns the package being exported. * @return the package being exported */ PackageElement getPackage(); /** * Returns the specific modules to which the package is being exported, * or null, if the package is exported to all modules which * have readability to this module. * @return the specific modules to which the package is being exported */ List getTargetModules(); } /** * An opened package of a module. * @since 9 * @spec JPMS */ interface OpensDirective extends Directive { /** * Returns the package being opened. * @return the package being opened */ PackageElement getPackage(); /** * Returns the specific modules to which the package is being open * or null, if the package is open all modules which * have readability to this module. * @return the specific modules to which the package is being opened */ List getTargetModules(); } /** * An implementation of a service provided by a module. * @since 9 * @spec JPMS */ interface ProvidesDirective extends Directive { /** * Returns the service being provided. * @return the service being provided */ TypeElement getService(); /** * Returns the implementations of the service being provided. * @return the implementations of the service being provided */ List getImplementations(); } /** * A reference to a service used by a module. * @since 9 * @spec JPMS */ interface UsesDirective extends Directive { /** * Returns the service that is used. * @return the service that is used */ TypeElement getService(); } }