org.grails.cli.compiler.GroovyCompilerConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grace-shell Show documentation

Grace Framework : Grace Shell

There is a newer version: 2023.1.0-RC1

/*
 * Copyright 2012-2023 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.grails.cli.compiler;

import java.util.List;

import org.grails.cli.compiler.grape.RepositoryConfiguration;

/**
 * Configuration for the {@link GroovyCompiler}.
 *
 * @author Phillip Webb
 * @author Andy Wilkinson
 * @since 2022.1.0
 */
public interface GroovyCompilerConfiguration {

    /**
     * Constant to be used when there is no {@link #getClasspath() classpath}.
     */
    String[] DEFAULT_CLASSPATH = { "." };

    /**
     * Returns the scope in which the compiler operates.
     *
     * @return the scope of the compiler
     */
    GroovyCompilerScope getScope();

    /**
     * Returns if import declarations should be guessed.
     *
     * @return {@code true} if imports should be guessed, otherwise {@code false}
     */
    boolean isGuessImports();

    /**
     * Returns if jar dependencies should be guessed.
     *
     * @return {@code true} if dependencies should be guessed, otherwise {@code false}
     */
    boolean isGuessDependencies();

    /**
     * Returns true if auto-configuration transformations should be applied.
     *
     * @return {@code true} if auto-configuration transformations should be applied,
     * otherwise {@code false}
     */
    boolean isAutoconfigure();

    /**
     * Returns the classpath for local resources.
     *
     * @return a path for local resources
     */
    String[] getClasspath();

    /**
     * Returns the configuration for the repositories that will be used by the compiler to
     * resolve dependencies.
     *
     * @return the repository configurations
     */
    List getRepositoryConfiguration();

    /**
     * Returns if running in quiet mode.
     *
     * @return {@code true} if running in quiet mode
     */
    boolean isQuiet();

}