/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2016-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.codemodel;

/**
 * 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;
    }

}
