org.gradle.api.internaltransform.Transformer 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
Show all versions of gradle-api Show documentation
Gradle 6.5 API redistribution.
/*
* Copyright 2018 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.internal.artifacts.transform;
import com.google.common.collect.ImmutableList;
import org.gradle.api.Describable;
import org.gradle.api.file.FileSystemLocation;
import org.gradle.api.internal.attributes.ImmutableAttributes;
import org.gradle.api.internal.tasks.TaskDependencyContainer;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.FileNormalizer;
import org.gradle.internal.fingerprint.FileCollectionFingerprinterRegistry;
import org.gradle.internal.hash.HashCode;
import org.gradle.work.InputChanges;
import javax.annotation.Nullable;
import java.io.File;
/**
* The actual code which needs to be executed to transform a file.
*
* This encapsulates the public interface {@link org.gradle.api.artifacts.transform.TransformAction} into an internal type.
*/
public interface Transformer extends Describable, TaskDependencyContainer {
Class getImplementationClass();
ImmutableAttributes getFromAttributes();
/**
* Whether the transformer requires dependencies of the transformed artifact to be injected.
*/
boolean requiresDependencies();
/**
* Whether the transformer requires {@link InputChanges} to be injected.
*/
boolean requiresInputChanges();
/**
* Whether the transformer is cacheable.
*/
boolean isCacheable();
ImmutableList transform(Provider inputArtifactProvider, File outputDir, ArtifactTransformDependencies dependencies, @Nullable InputChanges inputChanges);
/**
* The hash of the secondary inputs of the transformer.
*
* This includes the parameters and the implementation.
*/
HashCode getSecondaryInputHash();
void isolateParameters(FileCollectionFingerprinterRegistry fingerprinterRegistry);
Class getInputArtifactNormalizer();
Class getInputArtifactDependenciesNormalizer();
boolean isIsolated();
}