org.gradle.api.file.FileSystemOperations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2019 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.api.file;

import org.gradle.api.Action;
import org.gradle.api.Incubating;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.WorkResult;
import org.gradle.internal.service.scopes.Scope;
import org.gradle.internal.service.scopes.ServiceScope;


/**
 * Operations on the file system.
 *
 * An instance of this type can be injected into a task, plugin or other object by annotating a public constructor or property getter method with {@code javax.inject.Inject}.
 *
 * @since 6.0
 */
@ServiceScope({Scope.Build.class, Scope.Project.class})
public interface FileSystemOperations {

    /**
     * Creates a {@link CopySpec} which can later be used to copy files or create an archive. The given action is used
     * to configure the {@link CopySpec} before it is returned by this method.
     *
     * @param action Action to configure the CopySpec
     * @return The CopySpec
     * @since 8.5
     */
    @Incubating
    CopySpec copySpec(Action action);

    /**
     * Creates a {@link CopySpec} which can later be used to copy files or create an archive.
     *
     * @return a newly created copy spec
     * @since 8.5
     */
    @Incubating
    CopySpec copySpec();

    /**
     * Copies the specified files.
     * The given action is used to configure a {@link CopySpec}, which is then used to copy the files.
     *
     * @param action Action to configure the CopySpec
     * @return {@link WorkResult} that can be used to check if the copy did any work.
     */
    WorkResult copy(Action action);

    /**
     * Synchronizes the contents of a destination directory with some source directories and files.
     * The given action is used to configure a {@link CopySpec}, which is then used to synchronize the files.
     *
     * @param action action Action to configure the CopySpec.
     * @return {@link WorkResult} that can be used to check if the sync did any work.
     */
    WorkResult sync(Action action);

    /**
     * Deletes the specified files.
     * The given action is used to configure a {@link DeleteSpec}, which is then used to delete the files.
     *
     * @param action Action to configure the DeleteSpec
     * @return {@link WorkResult} that can be used to check if delete did any work.
     */
    WorkResult delete(Action action);

    /**
     * Creates and configures file access permissions. Differs from directory permissions due to
     * the default value the permissions start out with before the configuration is applied.
     * For details see {@link ConfigurableFilePermissions}.
     *
     * @param configureAction The configuration that gets applied to the newly created {@code FilePermissions}.
     *
     * @since 8.3
     */
    ConfigurableFilePermissions filePermissions(Action configureAction);

    /**
     * Creates and configures directory access permissions. Differs from file permissions due to
     * the default value the permissions start out with before the configuration is applied.
     * For details see {@link ConfigurableFilePermissions}.
     *
     * @param configureAction The configuration that gets applied to the newly created {@code FilePermissions}.
     *
     * @since 8.3
     */
    ConfigurableFilePermissions directoryPermissions(Action configureAction);

    /**
     * Creates file/directory access permissions and initializes them via a Unix style permission string.
     * For details see {@link ConfigurableFilePermissions#unix(String)}.
     * 

     * Doesn't have separate variants for files and directories, like other configuration methods,
     * because the Unix style permission input completely overwrites the default values, so
     * the distinction doesn't matter.
     *
     * @since 8.3
     */
    ConfigurableFilePermissions permissions(String unixNumericOrSymbolic);

    /**
     * Creates file/directory access permissions and initializes them via a Unix style numeric permissions.
     * For details see {@link ConfigurableFilePermissions#unix(int)}.
     * 
     * Doesn't have separate variants for files and directories, like other configuration methods,
     * because the Unix style permission input completely overwrites the default values, so
     * the distinction doesn't matter.
     *
     * @since 8.3
     */
    ConfigurableFilePermissions permissions(int unixNumeric);

    /**
     * {@link Provider} based version of {@link #permissions(String)},  to facilitate wiring into property chains.
     *
     * @since 8.3
     */
    Provider permissions(Provider permissions);
}