TestProject.java

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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 com.android.build.gradle.integration.common.fixture;

import com.android.annotations.NonNull;
import com.android.annotations.Nullable;

import java.io.File;
import java.io.IOException;

/**
 * Interface for a test project.
 */
public interface TestProject {

    /**
     * Creates all the project files
     * @param projectDir Directory to create the project files in.
     * @param buildScriptContent the buildScript content to add to the build.gradle if applicable.
     */
    void write(@NonNull File projectDir, @Nullable String buildScriptContent) throws IOException;

    /**
     * Returns whether the project contains a complete build.gradle.
     */
    boolean containsFullBuildScript();
}