/*
 * Copyright 2017 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.language.nativeplatform;

import org.gradle.api.Incubating;
import org.gradle.api.file.Directory;
import org.gradle.api.file.FileCollection;
import org.gradle.api.provider.Provider;
import org.gradle.nativeplatform.tasks.InstallExecutable;

/**
 * Represents a native component that produces an application installation.
 *
 * @since 4.5
 */
@Incubating
public interface ComponentWithInstallation extends ComponentWithNativeRuntime {
    /**
     * Returns the runtime libraries required for the installation. Includes the runtime libraries of the component's dependencies.
     */
    FileCollection getRuntimeLibraries();

    /**
     * Returns the installation directory.
     */
    Provider<Directory> getInstallDirectory();

    /**
     * Returns the install task.
     */
    Provider<? extends InstallExecutable> getInstallTask();
}
