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

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.6
/*
 * 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.Incubating;
import org.gradle.api.provider.Provider;

/**
 * Provides lazy access to the contents of a given file.
 *
 * @since 6.1
 */
@Incubating
public interface FileContents {

    /**
     * Gets a provider of the entire file contents as a single String.
     *
     * 
     * The file is read only once and only when the value is requested for the first time.
     * 
     * 
     * The returned provider won't have a value, i.e., {@link Provider#isPresent} will return {@code false} when:
     * 
     * 
     *     the underlying file does not exist;
     *     this {@link FileContents} is connected to a {@link Provider}{@code <}{@link RegularFile}{@code >} with no value;
     * 
     * 
     *     When the underlying file exists but reading it fails, the ensuing exception is permanently propagated to callers of
     *     {@link Provider#get}, {@link Provider#getOrElse}, {@link Provider#getOrNull} and {@link Provider#isPresent}.
     * 
     *
     * The returned provider cannot be queried at configuration time but can produce a configuration time provider
     * via {@link Provider#forUseAtConfigurationTime()}.
     *
     * @return provider of the entire file contents as a single String.
     */
    Provider getAsText();

    /**
     * Gets a provider of the entire file contents as a single byte array.
     *
     * 
     * The file is read only once and only when the value is requested for the first time.
     * 
     * 
     * The returned provider won't have a value, i.e., {@link Provider#isPresent} will return {@code false} when:
     * 
     * 
     *     the underlying file does not exist;
     *     this {@link FileContents} is connected to a {@link Provider}{@code <}{@link RegularFile}{@code >} with no value;
     * 
     * 
     *     When the underlying file exists but reading it fails, the ensuing exception is permanently propagated to callers of
     *     {@link Provider#get}, {@link Provider#getOrElse}, {@link Provider#getOrNull} and {@link Provider#isPresent}.
     * 
     *
     * The returned provider cannot be queried at configuration time but can produce a configuration time provider
     * via {@link Provider#forUseAtConfigurationTime()}.
     *
     * @return provider of the entire file contents as a single byte array.
     */
    Provider getAsBytes();
}