```
public final class PackageDefinition
 extends VaultDefinition 
                    
```
Package builder 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.

Field Summary

Fields
Modifier and Type	Field	Description
`private final DirectoryProperty`	`destinationDirectory`
`private final Property<String>`	`archiveBaseName`
`private final Property<String>`	`archiveAppendix`
`private final Property<String>`	`archiveExtension`
`private final Property<String>`	`archiveClassifier`
`private final Property<String>`	`archiveVersion`
`private final RegularFileProperty`	`archivePath`
`private final Property<String>`	`archiveFileName`
`private final File`	`pkgDir`
`private final File`	`metaDir`
`private final File`	`jcrDir`
`private final MapProperty<String, Any>`	`expandProperties`
`private final MapProperty<String, String>`	`manifestProperties`
`private final Property<String>`	`name`
`private final Property<String>`	`group`
`private final Property<String>`	`version`
`private final Property<String>`	`description`
`private final Property<String>`	`createdBy`
`private final ListProperty<FilterElement>`	`filterElements`
`private final Set<String>`	`filters`
`private final Set<String>`	`filterRoots`
`private final Collection<FilterElement>`	`filterEffectives`
`private final ListProperty<String>`	`nodeTypeLibs`
`private final ListProperty<String>`	`nodeTypeLines`
`private final MapProperty<String, Any>`	`properties`
`private final Map<String, Any>`	`fileProperties`

Constructor Summary

Constructors
Constructor	Description
`PackageDefinition(AemExtension aem)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`content(Function1<PackageDefinition, Unit> options)`	Hook for adding files to package being composed.
`final Unit`	`copyJcrFile(File file, String path)`
`final Unit`	`copyMetaFiles(Boolean skipExisting)`
`final Unit`	`expandFiles(List<String> filePatterns)`
`final File`	`compose()`	Compose a CRX package basing on configured definition.
`final DirectoryProperty`	`getDestinationDirectory()`
`final Property<String>`	`getArchiveBaseName()`
`final Property<String>`	`getArchiveAppendix()`
`final Property<String>`	`getArchiveExtension()`
`final Property<String>`	`getArchiveClassifier()`
`final Property<String>`	`getArchiveVersion()`
`final RegularFileProperty`	`getArchivePath()`	ZIP file path
`final Property<String>`	`getArchiveFileName()`	ZIP file name
`final File`	`getPkgDir()`
`final File`	`getMetaDir()`
`final File`	`getJcrDir()`
`final MapProperty<String, Any>`	`getExpandProperties()`
`final MapProperty<String, String>`	`getManifestProperties()`
`final Property<String>`	`getName()`	Name visible in CRX package manager
`final Property<String>`	`getGroup()`	Group for categorizing in CRX package manager
`final Property<String>`	`getVersion()`	Version visible in CRX package manager.
`final Property<String>`	`getDescription()`
`final Property<String>`	`getCreatedBy()`
`final ListProperty<FilterElement>`	`getFilterElements()`
`final Set<String>`	`getFilters()`
`final Set<String>`	`getFilterRoots()`
`final Collection<FilterElement>`	`getFilterEffectives()`
`final ListProperty<String>`	`getNodeTypeLibs()`
`final ListProperty<String>`	`getNodeTypeLines()`
`final MapProperty<String, Any>`	`getProperties()`	Additional entries added to file 'META-INF/vault/properties.xml'.
`final Map<String, Any>`	`getFileProperties()`	Any properties that could be used in any text file being a part of composed package.

Methods inherited from class com.cognifide.gradle.aem.common.pkg.PackageDefinition
acHandling, filter, filter, filters, filters, filters, filters, filters, isFilterDynamicAndNotRedundant, isFilterNeeded, isNodeTypeLib, nodeTypeLibs, nodeTypeLibs, nodeTypeLines, nodeTypeLines, nodeTypeReader, nodeTypes, nodeTypes, property, requiresRoot, toString
Methods inherited from class com.cognifide.gradle.aem.common.pkg.vault.VaultDefinition
equals, hashCode
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PackageDefinition
```
PackageDefinition(AemExtension aem)
```

Method Detail

content

 final Unit content(Function1<PackageDefinition, Unit> options)

Hook for adding files to package being composed.

copyJcrFile

 final Unit copyJcrFile(File file, String path)

copyMetaFiles

 final Unit copyMetaFiles(Boolean skipExisting)

expandFiles

 final Unit expandFiles(List<String> filePatterns)

compose
```
 final File compose()
```
Compose a CRX package basing on configured definition.

getDestinationDirectory

 final DirectoryProperty getDestinationDirectory()

getArchiveBaseName

 final Property<String> getArchiveBaseName()

getArchiveAppendix

 final Property<String> getArchiveAppendix()

getArchiveExtension

 final Property<String> getArchiveExtension()

getArchiveClassifier

 final Property<String> getArchiveClassifier()

getArchiveVersion

 final Property<String> getArchiveVersion()

getArchivePath

 final RegularFileProperty getArchivePath()

ZIP file path

getArchiveFileName

 final Property<String> getArchiveFileName()

ZIP file name

getPkgDir
```
 final File getPkgDir()
```

getMetaDir
```
 final File getMetaDir()
```

getJcrDir
```
 final File getJcrDir()
```

getExpandProperties

 final MapProperty<String, Any> getExpandProperties()

getManifestProperties

 final MapProperty<String, String> getManifestProperties()

getName
```
 final Property<String> getName()
```
Name visible in CRX package manager

getGroup
```
 final Property<String> getGroup()
```
Group for categorizing in CRX package manager

getVersion
```
 final Property<String> getVersion()
```
Version visible in CRX package manager.

getDescription

 final Property<String> getDescription()

getCreatedBy
```
 final Property<String> getCreatedBy()
```

getFilterElements

 final ListProperty<FilterElement> getFilterElements()

getFilters

@Internal() final Set<String> getFilters()

getFilterRoots

@Internal() final Set<String> getFilterRoots()

getFilterEffectives

 final Collection<FilterElement> getFilterEffectives()

getNodeTypeLibs

 final ListProperty<String> getNodeTypeLibs()

getNodeTypeLines

 final ListProperty<String> getNodeTypeLines()

getProperties
```
 final MapProperty<String, Any> getProperties()
```
Additional entries added to file 'META-INF/vault/properties.xml'.

getFileProperties
```
@Internal() final Map<String, Any> getFileProperties()
```
Any properties that could be used in any text file being a part of composed package.

Class PackageDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.cognifide.gradle.aem.common.pkg.PackageDefinition

Methods inherited from class com.cognifide.gradle.aem.common.pkg.vault.VaultDefinition

Methods inherited from class java.lang.Object

Constructor Detail

PackageDefinition

Method Detail

content

copyJcrFile

copyMetaFiles

expandFiles

compose

getDestinationDirectory

getArchiveBaseName

getArchiveAppendix

getArchiveExtension

getArchiveClassifier

getArchiveVersion

getArchivePath

getArchiveFileName

getPkgDir

getMetaDir

getJcrDir

getExpandProperties

getManifestProperties

getName

getGroup

getVersion

getDescription

getCreatedBy

getFilterElements

getFilters

getFilterRoots

getFilterEffectives

getNodeTypeLibs

getNodeTypeLines

getProperties

getFileProperties