org.gradle.apitransform.ArtifactTransform 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 2016 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.artifacts.transform;

import java.io.File;
import java.util.List;

/**
 * Base class for artifact transforms.
 *
 * Implementations must provide a public constructor. The constructor may optionally accept parameters, in which case it must be annotated with {@link javax.inject.Inject}. The following parameters are available:
 *
 * 
 * The objects provided to {@link org.gradle.api.ActionConfiguration#setParams(Object...)}.
 * 
 *
 * @deprecated Use {@link TransformAction} instead.
 * @since 3.4
 */
@Deprecated
public abstract class ArtifactTransform {
    private File outputDirectory;

    /**
     * Returns the workspace location for this transform, which is the directory that the transform should write its output files to.
     */
    public File getOutputDirectory() {
        return outputDirectory;
    }

    public void setOutputDirectory(File outputDirectory) {
        this.outputDirectory = outputDirectory;
    }

    /**
     * Transforms the given input artifact file or directory and returns the result.
     *
     * @param input The input file or directory.
     * @return The output files or directories. Can return an empty list.
     */
    public abstract List transform(File input);
}