ModuleTree.java

/*
 * Copyright (c) 2009, 2016, 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 com.sun.source.tree;

import java.util.List;


/**
 * A tree node for a module declaration.
 *
 * For example:
 * <pre>
 *    <em>annotations</em>
 *    [open] module <em>module-name</em> {
 *        <em>directives</em>
 *    }
 * </pre>
 *
 * @since 9
 */
public interface ModuleTree extends Tree {
    /**
     * Returns the annotations associated with this module declaration.
     * @return the annotations
     */
    List<? extends AnnotationTree> getAnnotations();

    /**
     * Returns the type of this module.
     * @return the type of this module
     */
    ModuleKind getModuleType();

    /**
     * Returns the name of the module.
     * @return the name of the module
     */
    ExpressionTree getName();

    /**
     * Returns the directives in the module declaration.
     * @return the directives in the module declaration
     */
    List<? extends DirectiveTree> getDirectives();

    /**
     * The kind of the module.
     */
    enum ModuleKind {
        /**
         * Open module.
         */
        OPEN,
        /**
         * Strong module.
         */
        STRONG;
    }

}