com.cognifide.gradle.aem.common.pkg

Class PackageDefinition

VltDefinition

com.cognifide.gradle.aem.common.pkg.PackageDefinition

public class PackageDefinition
extends VltDefinition

Package definition that could be used to compose CRX package in place.

This is programmatic approach to create ZIP file. API reflects Gradle's AbstractArchiveTask. Useful for writing complex custom tasks that cannot inherit from Gradle's ZIP task.

Constructor Detail

PackageDefinition

public PackageDefinition(@NotNull
                         AemExtension aem)

Package definition that could be used to compose CRX package in place.

This is programmatic approach to create ZIP file. API reflects Gradle's AbstractArchiveTask. Useful for writing complex custom tasks that cannot inherit from Gradle's ZIP task.

Method Detail

getDestinationDirectory

@NotNull
public java.io.File getDestinationDirectory()

setDestinationDirectory

public void setDestinationDirectory(@NotNull
                                    java.io.File p)

getArchiveBaseName

@NotNull
public java.lang.String getArchiveBaseName()

setArchiveBaseName

public void setArchiveBaseName(@NotNull
                               java.lang.String p)

getArchiveAppendix

@Nullable
public java.lang.String getArchiveAppendix()

setArchiveAppendix

public void setArchiveAppendix(@Nullable
                               java.lang.String p)

getArchiveExtension

@NotNull
public java.lang.String getArchiveExtension()

setArchiveExtension

public void setArchiveExtension(@NotNull
                                java.lang.String p)

getArchiveClassifier

@Nullable
public java.lang.String getArchiveClassifier()

setArchiveClassifier

public void setArchiveClassifier(@Nullable
                                 java.lang.String p)

getArchiveVersion

@NotNull
public java.lang.String getArchiveVersion()

setArchiveVersion

public void setArchiveVersion(@NotNull
                              java.lang.String value)

getArchivePath

@NotNull
public java.io.File getArchivePath()

ZIP file path

setArchivePath

public void setArchivePath(@NotNull
                           java.io.File value)

ZIP file path

getArchiveFileName

@NotNull
public java.lang.String getArchiveFileName()

ZIP file name

setArchiveFileName

public void setArchiveFileName(@NotNull
                               java.lang.String value)

ZIP file name

getPkgDir

@NotNull
public java.io.File getPkgDir()

Temporary directory being zipped to produce CRX package.

getMetaDir

@NotNull
public java.io.File getMetaDir()

getJcrDir

@NotNull
public java.io.File getJcrDir()

process

public void process(@NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageDefinition,kotlin.Unit> options)

Hook for customizing how package will be processed before zipping.

content

public void content(@NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageDefinition,kotlin.Unit> options)

Hook for adding files to package being composed.

copyJcrFile

public void copyJcrFile(@NotNull
                        java.io.File file,
                        @NotNull
                        java.lang.String path)

copyMetaFiles

public void copyMetaFiles(boolean skipExisting)

expandMetaFiles

public void expandMetaFiles(@NotNull
                            java.util.List<java.lang.String> filePatterns)

expandFiles

public void expandFiles(@NotNull
                        java.io.File dir,
                        @NotNull
                        java.util.List<java.lang.String> filePatterns)

compose

@NotNull
public java.io.File compose(@NotNull
                                     kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageDefinition,kotlin.Unit> definition)

Compose a CRX package basing on configured definition.