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 Summary

Constructors

Constructor and Description
PackageDefinition(AemExtension aem) Package definition that could be used to compose CRX package in place.

Method Summary

Modifier and Type	Method and Description
java.io.File	compose(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageDefinition,kotlin.Unit> definition) Compose a CRX package basing on configured definition.
void	content(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.pkg.PackageDefinition,kotlin.Unit> options) Hook for adding files to package being composed.
void	copyJcrFile(java.io.File file, java.lang.String path)
void	copyMetaFiles(boolean skipExisting)
void	expandFiles(java.io.File dir, java.util.List<java.lang.String> filePatterns)
void	expandMetaFiles(java.util.List<java.lang.String> filePatterns)
java.lang.String	getAppendix()
java.lang.String	getArchiveBaseName()
java.lang.String	getArchiveName() ZIP file name
java.io.File	getArchivePath() ZIP file path
java.lang.String	getBaseName()
java.lang.String	getClassifier()
java.io.File	getDestinationDir()
java.lang.String	getExtension()
java.io.File	getJcrDir()
java.io.File	getMetaDir()
java.io.File	getPkgDir() Temporary directory being zipped to produce CRX package.
void	process(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.
void	setAppendix(java.lang.String p)
void	setArchiveName(java.lang.String value) ZIP file name
void	setArchivePath(java.io.File value) ZIP file path
void	setBaseName(java.lang.String p)
void	setClassifier(java.lang.String p)
void	setDestinationDir(java.io.File p)
void	setExtension(java.lang.String p)

Methods inherited from class com.cognifide.gradle.aem.common.pkg.vlt.VltDefinition

ensureDefaults, filter, filters, filters, getCreatedBy, getDescription, getFilterEffectives, getFilterElements, getFilterRoots, getFilters, getGroup, getName, getNodeTypeLibs, getNodeTypeLines, getNodeTypes, getProperties, getVersion, property, setCreatedBy, setDescription, setFilterElements, setGroup, setName, setNodeTypeLibs, setNodeTypeLines, setProperties, setVersion

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

getDestinationDir

@NotNull
public java.io.File getDestinationDir()

setDestinationDir

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

getBaseName

@NotNull
public java.lang.String getBaseName()

setBaseName

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

getAppendix

@Nullable
public java.lang.String getAppendix()

setAppendix

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

getExtension

@NotNull
public java.lang.String getExtension()

setExtension

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

getClassifier

@Nullable
public java.lang.String getClassifier()

setClassifier

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

getArchivePath

@NotNull
public java.io.File getArchivePath()

ZIP file path

setArchivePath

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

ZIP file path

getArchiveBaseName

@NotNull
public java.lang.String getArchiveBaseName()

getArchiveName

@NotNull
public java.lang.String getArchiveName()

ZIP file name

setArchiveName

public void setArchiveName(@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.