All Implemented Interfaces:

com.cognifide.gradle.aem.AemTask , com.cognifide.gradle.common.CommonTask , kotlin.Comparable , org.gradle.api.Task , org.gradle.api.file.ContentFilterable , org.gradle.api.file.CopyProcessingSpec , org.gradle.api.file.CopySourceSpec , org.gradle.api.file.CopySpec , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.IConventionAware , org.gradle.api.internal.TaskInternal , org.gradle.api.internal.file.copy.CopySpecSource , org.gradle.api.plugins.ExtensionAware , org.gradle.api.tasks.util.PatternFilterable , org.gradle.util.Configurable
```
public class PackageCompose
 extends ZipTask implements AemTask 
                    
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final AemExtension`	`aem`
`private final DirectoryProperty`	`contentDir`
`private final DirectoryProperty`	`jcrRootDir`
`private final DirectoryProperty`	`metaDir`
`private final Property<String>`	`bundlePath`
`private final Property<Boolean>`	`bundleTest`
`private final Property<String>`	`nestedPath`
`private final Property<Boolean>`	`nestedValidation`
`private final Property<Boolean>`	`checksumGenerated`
`private final VaultDefinition`	`vaultDefinition`
`private final DirectoryProperty`	`vaultDir`
`private final DirectoryProperty`	`vaultHooksDir`
`private final RegularFileProperty`	`vaultFilterOriginFile`
`private final RegularFileProperty`	`vaultFilterFile`
`private final Property<Boolean>`	`vaultFilters`
`private final RegularFileProperty`	`vaultNodeTypesFile`
`private final ListProperty<BundleInstalled>`	`bundlesInstalled`
`private final ListProperty<PackageNested>`	`packagesNested`
`private final PackageFileFilter`	`fileFilter`
`private Function1<CopySpec, Unit>`	`fileFilterDelegate`
`private final List<InputChangesAwareTaskAction>`	`actions`
`private final Boolean`	`allowZip64`
`private final Property<String>`	`archiveAppendix`
`private final Property<String>`	`archiveBaseName`
`private final Property<String>`	`archiveClassifier`
`private final DirectoryProperty`	`archiveDestinationDirectory`
`private final Property<String>`	`archiveExtension`
`private final RegularFileProperty`	`archiveFile`
`private final Property<String>`	`archiveName`
`private final Property<Boolean>`	`archivePreserveFileTimestamps`
`private final Property<Boolean>`	`archiveReproducibleFileOrder`
`private final Property<String>`	`archiveVersion`
`private final CommonExtension`	`common`
`private final ConventionMapping`	`conventionMapping`
`private Function1<ProgressIndicator, Unit>`	`copyProgress`
`private final DefaultTaskDependency`	`dependencies`
`private final String`	`description`
`private final Boolean`	`enabled`
`private final ZipEntryCompression`	`entryCompression`
`private final ExtensibleDynamicObject`	`extensibleDynamicObject`
`private final DefaultTaskDependency`	`finalizedBy`
`private final String`	`group`
`private final Boolean`	`hasCustomActions`
`private final TaskIdentity<?>`	`identity`
`private final Boolean`	`impliesSubProjects`
`private final Logger`	`logger`
`private final LoggingManagerInternal`	`loggingManager`
`private final CopySpecInternal`	`mainSpec`
`private final String`	`metadataCharset`
`private final DefaultTaskDependency`	`mustRunAfter`
`private final ObservableList`	`observableActionList`
`private final AndSpec<Task>`	`onlyIfSpec`
`private final ProjectInternal`	`project`
`private final Set<Provider<Out BuildService<?>>>`	`requiredServices`
`private final CopySpecInternal`	`rootSpec`
`private final ServiceRegistry`	`services`
`private final DefaultTaskDependency`	`shouldRunAfter`
`private final TaskStateInternal`	`state`
`private final TaskDestroyables`	`taskDestroyables`
`private final TaskInputsInternal`	`taskInputs`
`private final TaskLocalStateInternal`	`taskLocalState`
`private final TaskMutator`	`taskMutator`
`private final TaskOutputsInternal`	`taskOutputs`
`private final Property<Duration>`	`timeout`

Constructor Summary

Constructors
Constructor	Description
`PackageCompose()`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`bundleBuilt(Function1<BundleInstalledBuilt, Unit> options)`	Allows to customize install path or run mode of built bundle to be installed.
`final Unit`	`vaultDefinition(Function1<VaultDefinition, Unit> options)`
`final Unit`	`vault(Function1<VaultDefinition, Unit> options)`
`Unit`	`projectsEvaluated()`
`final Unit`	`fromDefaults()`
`final Unit`	`fromMeta(Object metaDir)`
`final Unit`	`fromRoot(Object dir)`
`final Unit`	`fromBundlesInstalled(ListProperty<BundleInstalled> bundles)`
`final Unit`	`fromPackagesNested(ListProperty<PackageNested> pkgs)`
`final Unit`	`fromVaultHooks(Object dir)`
`final Unit`	`withBundleBuilt()`
`final Unit`	`withBundlesInstalled(ListProperty<BundleInstalled> others)`
`final Unit`	`withPackagesNested(ListProperty<PackageNested> others)`
`final Unit`	`withVaultFilters(RegularFileProperty file)`
`final Unit`	`withVaultNodeTypes(RegularFileProperty file)`
`final Unit`	`withVaultDefinition(VaultDefinition other)`
`final Unit`	`mergePackageProject(String projectPath)`
`final Unit`	`mergePackage(String taskPath)`
`final Unit`	`mergePackage(TaskProvider<PackageCompose> task)`
`final Unit`	`nestPackage(Object dependencyNotation, Function1<PackageNestedResolved, Unit> options)`
`final Unit`	`nestPackageProject(String projectPath, Function1<PackageNestedBuilt, Unit> options)`
`final Unit`	`nestPackageBuilt(String taskPath, Function1<PackageNestedBuilt, Unit> options)`
`final Unit`	`nestPackageBuilt(TaskProvider<PackageCompose> task, Function1<PackageNestedBuilt, Unit> options)`
`final Unit`	`installBundle(Object dependencyNotation, Function1<BundleInstalledResolved, Unit> options)`
`final Unit`	`installBundleProject(String projectPath, Function1<BundleInstalledBuilt, Unit> options)`
`final Unit`	`installBundleBuilt(String taskPath, Function1<BundleInstalledBuilt, Unit> options)`
`final Unit`	`installBundleBuilt(TaskProvider<Jar> task, Function1<BundleInstalledBuilt, Unit> options)`
`final Unit`	`definition(Function0<Unit> definition)`	Override default behavior for composing this package.
`final Unit`	`noDefaults()`	Clear default behavior for composing this package.
`final Unit`	`merging(Function1<PackageCompose, Unit> action)`	Override default behavior for merging this package into assembly package.
`final Unit`	`merged(Function1<PackageCompose, Unit> action)`	Add some extra behavior when merging this package into assembly package.
`final Unit`	`fileFilter(Function1<PackageFileFilter, Unit> configurer)`
`final AemExtension`	`getAem()`
`final DirectoryProperty`	`getContentDir()`
`final DirectoryProperty`	`getJcrRootDir()`
`final DirectoryProperty`	`getMetaDir()`
`final Property<String>`	`getBundlePath()`	Content path for OSGi bundle jars being placed in CRX package.
`final Property<Boolean>`	`getBundleTest()`	Controls running tests for built bundles before placing them at bundlePath.
`final Property<String>`	`getNestedPath()`	Content path for CRX sub-packages being placed in CRX package being built.
`final Property<Boolean>`	`getNestedValidation()`	Controls validating built packages before placing them at nestedPath.
`final Property<Boolean>`	`getChecksumGenerated()`	Controls generation of MD5 checksum file after composing a package.
`final VaultDefinition`	`getVaultDefinition()`	Defines properties being used to generate CRX package metadata files.
`final DirectoryProperty`	`getVaultDir()`
`final DirectoryProperty`	`getVaultHooksDir()`
`final RegularFileProperty`	`getVaultFilterOriginFile()`
`final RegularFileProperty`	`getVaultFilterFile()`
`final Property<Boolean>`	`getVaultFilters()`
`final RegularFileProperty`	`getVaultNodeTypesFile()`
`final ListProperty<BundleInstalled>`	`getBundlesInstalled()`
`final ListProperty<PackageNested>`	`getPackagesNested()`
`final PackageFileFilter`	`getFileFilter()`
`final Function1<CopySpec, Unit>`	`getFileFilterDelegate()`
`final CommonExtension`	`getCommon()`
`final Function1<ProgressIndicator, Unit>`	`getCopyProgress()`
`final Unit`	`setFileFilterDelegate(@Internal() Function1<CopySpec, Unit> fileFilterDelegate)`
`final Unit`	`setCopyProgress(@Internal() Function1<ProgressIndicator, Unit> copyProgress)`

Methods inherited from class org.gradle.api.DefaultTask
appendParallelSafeAction, assertDynamicObject, compareTo, configure, convertClosureToAction, createNewOnlyIfSpec, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getRequiredServices, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskExecutionAccessBroadcaster, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, isEnabled, isHasCustomActions, mustRunAfter, notifyProjectAccess, notifyTaskDependenciesAccess, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService, wrap, wrap
Methods inherited from class org.gradle.api.tasks.AbstractCopyTask
conventionMapping, conventionMapping, getConventionMapping
Methods inherited from class com.cognifide.gradle.common.tasks.ZipTask
createCopyAction, getCompressor, getEntryCompression, getMetadataCharset, isZip64, projectEvaluated, setEntryCompression, setMetadataCharset, setZip64, taskGraphReady
Methods inherited from class org.gradle.api.tasks.bundling.Zip
createCopyActionExecuter, getAppendix, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchiveName, getArchivePath, getArchiveVersion, getBaseName, getClassifier, getDestinationDir, getDestinationDirectory, getExtension, getVersion, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setAppendix, setArchiveName, setBaseName, setClassifier, setDestinationDir, setExtension, setPreserveFileTimestamps, setReproducibleFileOrder, setVersion
Methods inherited from class org.gradle.api.tasks.bundling.AbstractArchiveTask
createRootSpec, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirMode, getDirectoryFileTreeFactory, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with
Methods inherited from class kotlin.Comparable
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PackageCompose
```
PackageCompose()
```

Method Detail

bundleBuilt
```
 final Unit bundleBuilt(Function1<BundleInstalledBuilt, Unit> options)
```
Allows to customize install path or run mode of built bundle to be installed.

vaultDefinition

 final Unit vaultDefinition(Function1<VaultDefinition, Unit> options)

vault

 final Unit vault(Function1<VaultDefinition, Unit> options)

projectsEvaluated
```
 Unit projectsEvaluated()
```

fromDefaults
```
 final Unit fromDefaults()
```

fromMeta
```
 final Unit fromMeta(Object metaDir)
```

fromRoot
```
 final Unit fromRoot(Object dir)
```

fromBundlesInstalled

 final Unit fromBundlesInstalled(ListProperty<BundleInstalled> bundles)

fromPackagesNested

 final Unit fromPackagesNested(ListProperty<PackageNested> pkgs)

fromVaultHooks
```
 final Unit fromVaultHooks(Object dir)
```

withBundleBuilt
```
 final Unit withBundleBuilt()
```

withBundlesInstalled

 final Unit withBundlesInstalled(ListProperty<BundleInstalled> others)

withPackagesNested

 final Unit withPackagesNested(ListProperty<PackageNested> others)

withVaultFilters

 final Unit withVaultFilters(RegularFileProperty file)

withVaultNodeTypes

 final Unit withVaultNodeTypes(RegularFileProperty file)

withVaultDefinition

 final Unit withVaultDefinition(VaultDefinition other)

mergePackageProject

 final Unit mergePackageProject(String projectPath)

mergePackage

 final Unit mergePackage(String taskPath)

mergePackage

 final Unit mergePackage(TaskProvider<PackageCompose> task)

nestPackage

 final Unit nestPackage(Object dependencyNotation, Function1<PackageNestedResolved, Unit> options)

nestPackageProject

 final Unit nestPackageProject(String projectPath, Function1<PackageNestedBuilt, Unit> options)

nestPackageBuilt

 final Unit nestPackageBuilt(String taskPath, Function1<PackageNestedBuilt, Unit> options)

nestPackageBuilt

 final Unit nestPackageBuilt(TaskProvider<PackageCompose> task, Function1<PackageNestedBuilt, Unit> options)

installBundle

 final Unit installBundle(Object dependencyNotation, Function1<BundleInstalledResolved, Unit> options)

installBundleProject

 final Unit installBundleProject(String projectPath, Function1<BundleInstalledBuilt, Unit> options)

installBundleBuilt

 final Unit installBundleBuilt(String taskPath, Function1<BundleInstalledBuilt, Unit> options)

installBundleBuilt

 final Unit installBundleBuilt(TaskProvider<Jar> task, Function1<BundleInstalledBuilt, Unit> options)

definition
```
 final Unit definition(Function0<Unit> definition)
```
Override default behavior for composing this package.

noDefaults
```
 final Unit noDefaults()
```
Clear default behavior for composing this package.

merging
```
 final Unit merging(Function1<PackageCompose, Unit> action)
```
Override default behavior for merging this package into assembly package.

merged
```
 final Unit merged(Function1<PackageCompose, Unit> action)
```
Add some extra behavior when merging this package into assembly package.

fileFilter

 final Unit fileFilter(Function1<PackageFileFilter, Unit> configurer)

getAem
```
 final AemExtension getAem()
```

getContentDir

 final DirectoryProperty getContentDir()

getJcrRootDir

 final DirectoryProperty getJcrRootDir()

getMetaDir
```
 final DirectoryProperty getMetaDir()
```

getBundlePath
```
 final Property<String> getBundlePath()
```
Content path for OSGi bundle jars being placed in CRX package.

getBundleTest
```
 final Property<Boolean> getBundleTest()
```
Controls running tests for built bundles before placing them at bundlePath.

getNestedPath
```
 final Property<String> getNestedPath()
```
Content path for CRX sub-packages being placed in CRX package being built.

getNestedValidation
```
 final Property<Boolean> getNestedValidation()
```
Controls validating built packages before placing them at nestedPath.

getChecksumGenerated
```
 final Property<Boolean> getChecksumGenerated()
```
Controls generation of MD5 checksum file after composing a package.

getVaultDefinition
```
 final VaultDefinition getVaultDefinition()
```
Defines properties being used to generate CRX package metadata files.

getVaultDir
```
 final DirectoryProperty getVaultDir()
```

getVaultHooksDir

 final DirectoryProperty getVaultHooksDir()

getVaultFilterOriginFile

 final RegularFileProperty getVaultFilterOriginFile()

getVaultFilterFile

 final RegularFileProperty getVaultFilterFile()

getVaultFilters

 final Property<Boolean> getVaultFilters()

getVaultNodeTypesFile

 final RegularFileProperty getVaultNodeTypesFile()

getBundlesInstalled

 final ListProperty<BundleInstalled> getBundlesInstalled()

getPackagesNested

 final ListProperty<PackageNested> getPackagesNested()

getFileFilter

 final PackageFileFilter getFileFilter()

getFileFilterDelegate

 final Function1<CopySpec, Unit> getFileFilterDelegate()

getCommon
```
 final CommonExtension getCommon()
```

getCopyProgress

 final Function1<ProgressIndicator, Unit> getCopyProgress()

setFileFilterDelegate

 final Unit setFileFilterDelegate(@Internal() Function1<CopySpec, Unit> fileFilterDelegate)

setCopyProgress

 final Unit setCopyProgress(@Internal() Function1<ProgressIndicator, Unit> copyProgress)

Class PackageCompose

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.gradle.api.DefaultTask

Methods inherited from class org.gradle.api.tasks.AbstractCopyTask

Methods inherited from class com.cognifide.gradle.common.tasks.ZipTask

Methods inherited from class org.gradle.api.tasks.bundling.Zip

Methods inherited from class org.gradle.api.tasks.bundling.AbstractArchiveTask

Methods inherited from class kotlin.Comparable

Methods inherited from class java.lang.Object

Constructor Detail

PackageCompose

Method Detail

bundleBuilt

vaultDefinition

vault

projectsEvaluated

fromDefaults

fromMeta

fromRoot

fromBundlesInstalled

fromPackagesNested

fromVaultHooks

withBundleBuilt

withBundlesInstalled

withPackagesNested

withVaultFilters

withVaultNodeTypes

withVaultDefinition

mergePackageProject

mergePackage

mergePackage

nestPackage

nestPackageProject

nestPackageBuilt

nestPackageBuilt

installBundle

installBundleProject

installBundleBuilt

installBundleBuilt

definition

noDefaults

merging

merged

fileFilter

getAem

getContentDir

getJcrRootDir

getMetaDir

getBundlePath

getBundleTest

getNestedPath

getNestedValidation

getChecksumGenerated

getVaultDefinition

getVaultDir

getVaultHooksDir

getVaultFilterOriginFile

getVaultFilterFile

getVaultFilters

getVaultNodeTypesFile

getBundlesInstalled

getPackagesNested

getFileFilter

getFileFilterDelegate

getCommon

getCopyProgress

setFileFilterDelegate

setCopyProgress