/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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 1.0.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<RepositoryConfiguration> getRepositoryConfiguration();

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

}
