org.gradle.api.tasks.bundling.AbstractArchiveTask 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 5.5.1 API redistribution.
/*
* Copyright 2009 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.tasks.bundling;
import groovy.lang.Closure;
import org.gradle.api.Action;
import org.gradle.api.file.CopySpec;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.RegularFile;
import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.internal.file.copy.CopyActionExecuter;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.model.ReplacedBy;
import org.gradle.api.provider.Property;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.AbstractCopyTask;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.OutputFile;
import org.gradle.internal.nativeplatform.filesystem.FileSystem;
import org.gradle.internal.reflect.Instantiator;
import org.gradle.util.GUtil;
import javax.annotation.Nullable;
import java.io.File;
import java.util.concurrent.Callable;
/**
* {@code AbstractArchiveTask} is the base class for all archive tasks.
*/
public abstract class AbstractArchiveTask extends AbstractCopyTask {
// All of these field names are really long to prevent collisions with the groovy setters.
// Groovy will try to set the private fields if given the opportunity.
// This makes it much more difficult for this to happen accidentally.
private final DirectoryProperty archiveDestinationDirectory;
private final RegularFileProperty archiveFile;
private final Property archiveName;
private final Property archiveBaseName;
private final Property archiveAppendix;
private final Property archiveVersion;
private final Property archiveExtension;
private final Property archiveClassifier;
private final Property archivePreserveFileTimestamps;
private final Property archiveReproducibleFileOrder;
public AbstractArchiveTask() {
ObjectFactory objectFactory = getProject().getObjects();
archiveDestinationDirectory = objectFactory.directoryProperty();
archiveBaseName = objectFactory.property(String.class);
archiveAppendix = objectFactory.property(String.class);
archiveVersion = objectFactory.property(String.class);
archiveExtension = objectFactory.property(String.class);
archiveClassifier = objectFactory.property(String.class).value("");
archiveName = objectFactory.property(String.class);
archiveName.set(getProject().provider(new Callable() {
@Override
public String call() throws Exception {
// [baseName]-[appendix]-[version]-[classifier].[extension]
String name = GUtil.elvis(archiveBaseName.getOrNull(), "");
name += maybe(name, archiveAppendix.getOrNull());
name += maybe(name, archiveVersion.getOrNull());
name += maybe(name, archiveClassifier.getOrNull());
String extension = archiveExtension.getOrNull();
name += GUtil.isTrue(extension) ? "." + extension : "";
return name;
}
}));
archiveFile = objectFactory.fileProperty();
archiveFile.set(archiveDestinationDirectory.file(archiveName));
archivePreserveFileTimestamps = objectFactory.property(Boolean.class).value(true);
archiveReproducibleFileOrder = objectFactory.property(Boolean.class).value(false);
}
private static String maybe(@Nullable String prefix, @Nullable String value) {
if (GUtil.isTrue(value)) {
if (GUtil.isTrue(prefix)) {
return "-".concat(value);
} else {
return value;
}
}
return "";
}
/**
* Returns the archive name. If the name has not been explicitly set, the pattern for the name is:
* [archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]
*
* @return the archive name.
* @deprecated Use {@link #getArchiveFileName()}
*/
@Deprecated
@ReplacedBy("archiveFileName")
public String getArchiveName() {
return archiveName.get();
}
/**
* Sets the archive name.
*
* @param name the archive name.
* @deprecated Use {@link #getArchiveFileName()}
*/
@Deprecated
public void setArchiveName(String name) {
archiveName.set(name);
}
/**
* Returns the archive name. If the name has not been explicitly set, the pattern for the name is:
* [archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]
*
* @return the archive name.
* @since 5.1
*/
@Internal("Represented as part of archiveFile")
public Property getArchiveFileName() {
return archiveName;
}
/**
* The path where the archive is constructed. The path is simply the {@code destinationDirectory} plus the {@code archiveFileName}.
*
* @return a File object with the path to the archive
* @deprecated Use {@link #getArchiveFile()}
*/
@Deprecated
@ReplacedBy("archiveFile")
public File getArchivePath() {
return getArchiveFile().get().getAsFile();
}
/**
* The {@link RegularFile} where the archive is constructed.
* The path is simply the {@code destinationDirectory} plus the {@code archiveFileName}.
*
* @return a {@link RegularFile} object with the path to the archive
* @since 5.1
*/
@OutputFile
@SuppressWarnings("DanglingJavadoc")
public Provider getArchiveFile() {
// TODO: Turn this into an `@implSpec` annotation on the comment above:
// https://github.com/gradle/gradle/issues/7486
/**
* This returns a provider of {@link RegularFile} instead of {@link RegularFileProperty} in order to
* prevent users calling {@link org.gradle.api.provider.Property#set} and causing a plugin or users using
* {@link AbstractArchiveTask#getArchivePath()} to break or have strange behaviour.
* An example can be found
* here.
*/
return archiveFile;
}
/**
* Returns the directory where the archive is generated into.
*
* @return the directory
* @deprecated Use {@link #getDestinationDirectory()}
*/
@Deprecated
@ReplacedBy("destinationDirectory")
public File getDestinationDir() {
return archiveDestinationDirectory.getAsFile().get();
}
/**
* Sets the destination dir.
*
* @deprecated Use {@link #getDestinationDirectory()}
*/
@Deprecated
public void setDestinationDir(File destinationDir) {
archiveDestinationDirectory.set(getProject().file(destinationDir));
}
/**
* The directory where the archive will be placed.
*
* @since 5.1
*/
@Internal("Represented by the archiveFile")
public DirectoryProperty getDestinationDirectory() {
return archiveDestinationDirectory;
}
/**
* Returns the base name of the archive.
*
* @return the base name. May be null.
* @deprecated Use {@link #getArchiveBaseName()}
*/
@Nullable
@Deprecated
@ReplacedBy("archiveBaseName")
public String getBaseName() {
return archiveBaseName.getOrNull();
}
/**
* Sets the base name.
*
* @deprecated Use {@link #getArchiveBaseName()}
*/
@Deprecated
public void setBaseName(@Nullable String baseName) {
this.archiveBaseName.set(baseName);
}
/**
* Returns the base name of the archive.
*
* @return the base name. Internal property may be null.
* @since 5.1
*/
@Internal("Represented as part of archiveFile")
public Property getArchiveBaseName() {
return archiveBaseName;
}
/**
* Returns the appendix part of the archive name, if any.
*
* @return the appendix. May be null
* @deprecated Use {@link #getArchiveAppendix()}
*/
@Nullable
@Deprecated
@ReplacedBy("archiveAppendix")
public String getAppendix() {
return archiveAppendix.getOrNull();
}
/**
* Sets the appendix.
*
* @deprecated Use {@link #getArchiveAppendix()}
*/
@Deprecated
public void setAppendix(@Nullable String appendix) {
this.archiveAppendix.set(appendix);
}
/**
* Returns the appendix part of the archive name, if any.
*
* @return the appendix. May be null
* @since 5.1
*/
@Internal("Represented as part of archiveFile")
public Property getArchiveAppendix() {
return archiveAppendix;
}
/**
* Returns the version part of the archive name, if any.
*
* @return the version. May be null.
* @deprecated Use {@link #getArchiveVersion()}
*/
@Nullable
@Deprecated
@ReplacedBy("archiveVersion")
public String getVersion() {
return archiveVersion.getOrNull();
}
/**
* Sets the version.
*
* @deprecated Use {@link #getArchiveVersion()}
*/
@Deprecated
public void setVersion(@Nullable String version) {
this.archiveVersion.set(version);
}
/**
* Returns the version part of the archive name.
*
* @return the version. Internal property may be null.
* @since 5.1
*/
@Internal("Represented as part of archiveFile")
public Property getArchiveVersion() {
return this.archiveVersion;
}
/**
* Returns the extension part of the archive name.
* @deprecated Use {@link #getArchiveExtension()}
*/
@Nullable
@Deprecated
@ReplacedBy("archiveExtension")
public String getExtension() {
return archiveExtension.getOrNull();
}
/**
* Sets the extension.
*
* @deprecated Use {@link #getArchiveExtension()}
*/
@Deprecated
public void setExtension(@Nullable String extension) {
this.archiveExtension.set(extension);
}
/**
* Returns the extension part of the archive name.
* @since 5.1
*/
@Internal("Represented as part of archiveFile")
public Property getArchiveExtension() {
return archiveExtension;
}
/**
* Returns the classifier part of the archive name, if any.
*
* @return The classifier. May be null.
* @deprecated Use {@link #getArchiveClassifier()}
*/
@Nullable
@Deprecated
@ReplacedBy("archiveClassifier")
public String getClassifier() {
return archiveClassifier.getOrNull();
}
/**
* Sets the classifier.
*
* @deprecated Use {@link #getArchiveClassifier()}
*/
@Deprecated
public void setClassifier(@Nullable String classifier) {
this.archiveClassifier.set(classifier);
}
/**
* Returns the classifier part of the archive name, if any.
*
* @return The classifier. Internal property may be null.
*
* @since 5.1
*/
@Internal("Represented as part of archiveFile")
public Property getArchiveClassifier() {
return archiveClassifier;
}
/**
* Specifies the destination directory *inside* the archive for the files.
* The destination is evaluated as per {@link org.gradle.api.Project#file(Object)}.
* Don't mix it up with {@link #getDestinationDirectory()} which specifies the output directory for the archive.
*
* @param destPath destination directory *inside* the archive for the files
* @return this
*/
@Override
public AbstractArchiveTask into(Object destPath) {
super.into(destPath);
return this;
}
/**
* Creates and configures a child {@code CopySpec} with a destination directory *inside* the archive for the files.
* The destination is evaluated as per {@link org.gradle.api.Project#file(Object)}.
* Don't mix it up with {@link #getDestinationDirectory()} which specifies the output directory for the archive.
*
* @param destPath destination directory *inside* the archive for the files
* @param configureClosure The closure to use to configure the child {@code CopySpec}.
* @return this
*/
@Override
public AbstractArchiveTask into(Object destPath, Closure configureClosure) {
super.into(destPath, configureClosure);
return this;
}
/**
* Creates and configures a child {@code CopySpec} with a destination directory *inside* the archive for the files.
* The destination is evaluated as per {@link org.gradle.api.Project#file(Object)}.
* Don't mix it up with {@link #getDestinationDirectory()} which specifies the output directory for the archive.
*
* @param destPath destination directory *inside* the archive for the files
* @param copySpec The closure to use to configure the child {@code CopySpec}.
* @return this
*/
@Override
public CopySpec into(Object destPath, Action copySpec) {
super.into(destPath, copySpec);
return this;
}
/**
* Specifies whether file timestamps should be preserved in the archive.
*
* If false this ensures that archive entries have the same time for builds between different machines, Java versions and operating systems.
*
*
* @since 3.4
* @return true if file timestamps should be preserved for archive entries
*/
@Input
public boolean isPreserveFileTimestamps() {
return archivePreserveFileTimestamps.get();
}
/**
* Specifies whether file timestamps should be preserved in the archive.
*
* If false this ensures that archive entries have the same time for builds between different machines, Java versions and operating systems.
*
*
* @since 3.4
* @param preserveFileTimestamps true if file timestamps should be preserved for archive entries
*/
public void setPreserveFileTimestamps(boolean preserveFileTimestamps) {
this.archivePreserveFileTimestamps.set(preserveFileTimestamps);
}
/**
* Specifies whether to enforce a reproducible file order when reading files from directories.
*
* Gradle will then walk the directories on disk which are part of this archive in a reproducible order
* independent of file systems and operating systems.
* This helps Gradle reliably produce byte-for-byte reproducible archives.
*
*
* @since 3.4
* @return true if the files should read from disk in a reproducible order.
*/
@Input
public boolean isReproducibleFileOrder() {
return archiveReproducibleFileOrder.get();
}
/**
* Specifies whether to enforce a reproducible file order when reading files from directories.
*
* Gradle will then walk the directories on disk which are part of this archive in a reproducible order
* independent of file systems and operating systems.
* This helps Gradle reliably produce byte-for-byte reproducible archives.
*
*
* @since 3.4
* @param reproducibleFileOrder true if the files should read from disk in a reproducible order.
*/
public void setReproducibleFileOrder(boolean reproducibleFileOrder) {
this.archiveReproducibleFileOrder.set(reproducibleFileOrder);
}
@Override
protected CopyActionExecuter createCopyActionExecuter() {
Instantiator instantiator = getInstantiator();
FileSystem fileSystem = getFileSystem();
return new CopyActionExecuter(instantiator, fileSystem, isReproducibleFileOrder());
}
}