GradleEnvironment.java

/*
 * Copyright 2011 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
 *
 *      http://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.gradle.tooling.model.build;

import org.gradle.api.Incubating;

import java.io.File;

/**
 * Informs about the Gradle environment, for example the Gradle version.
 * <p>
 * See example in {@link BuildEnvironment}
 *
 * @since 1.0-milestone-8
 */
public interface GradleEnvironment {

    /**
     * Informs about the Gradle user home.
     *
     * @since 2.4
     */
    @Incubating
    File getGradleUserHome();

    /**
     * Informs about the Gradle version.
     *
     * @since 1.0-milestone-8
     */
    String getGradleVersion();

}