/*

 * Copyright (c) 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.codemodel.internal;

/**

 * Represents a Java module {@code requires} directive.

 * For example {@code "requires foo.bar;"} or {@code "requires public foo.baz;"}.

 * @author Tomas Kraus

 */

public class JRequiresDirective extends JModuleDirective {

    /** Public readability modifier. */

    final boolean isPublic;

    /** Static modifier. */

    final boolean isStatic;

    /**

     * Creates an instance of Java module {@code requires} directive.

     * @param name name of required module or service.

     * @param isPublic Use {@code public} modifier.

     * @param isStatic Use {@code static} modifier.

     * @throws IllegalArgumentException if the name argument is {@code null}.

     */

    JRequiresDirective(final String name, final boolean isPublic, final boolean isStatic) {

        super(name);

        this.isPublic = isPublic;

        this.isStatic = isStatic;

    }

    /**

     * Gets the type of this module directive.

     * @return type of this module directive. Will always return {@code Type.RequiresDirective}.

     */

    @Override

    public Type getType() {

        return Type.RequiresDirective;

    }

    /**

     * Print source code of {@code requires} module directive modifiers:

     * {@code public} and {@code static} keywords for module dependency.

     * @param f Java code formatter.

     */

    protected void generateModifiers(final JFormatter f) {

        if (isPublic) {

            f.p("public");

        }

        if (isStatic) {

            f.p("static");

        }

    }

    /**

     * Print source code of this module directive.

     * @param f Java code formatter.

     * @return provided instance of Java code formatter.

     */

    @Override

    public JFormatter generate(final JFormatter f) {

        f.p("requires");

        generateModifiers(f);

        f.p(name);

        f.p(';').nl();

        return f;

    }

}