Package org.apache.sling.feature.scanner
Class ContentPackageDescriptor
- java.lang.Object
-
- org.apache.sling.feature.scanner.Descriptor
-
- org.apache.sling.feature.scanner.ArtifactDescriptor
-
- org.apache.sling.feature.scanner.ContentPackageDescriptor
-
public abstract class ContentPackageDescriptor extends ArtifactDescriptor
Information about a content package.- Since:
- 2.3.0
-
-
Constructor Summary
Constructors Constructor Description ContentPackageDescriptor(String name)
Constructor for the descriptor
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract List<BundleDescriptor>
getBundles()
Get the included bundlesabstract List<org.apache.sling.feature.Configuration>
getConfigurations()
Get the included configurationsabstract List<String>
getContentPaths()
Get the content pathsabstract Properties
getPackageProperties()
Get the package propertiesabstract ContentPackageDescriptor
getParentContentPackage()
Get the parent content packageabstract String
getParentContentPath()
Get the parent content pathboolean
hasEmbeddedArtifacts()
Check whether the package has embedded artifactsboolean
isEmbeddedInContentPackage()
Whether this artifact is embedded in a content packageString
toString()
-
Methods inherited from class org.apache.sling.feature.scanner.ArtifactDescriptor
getArtifact, getArtifactFile, getManifest
-
Methods inherited from class org.apache.sling.feature.scanner.Descriptor
aggregate, checkLocked, getCapabilities, getDynamicImportedPackages, getExportedPackages, getImportedPackages, getName, getRequirements, isLocked, lock
-
-
-
-
Constructor Detail
-
ContentPackageDescriptor
public ContentPackageDescriptor(String name)
Constructor for the descriptor- Parameters:
name
- The name- Throws:
IllegalArgumentException
- if name isnull
-
-
Method Detail
-
getContentPaths
public abstract List<String> getContentPaths()
Get the content paths- Returns:
- The list of content paths
-
getBundles
public abstract List<BundleDescriptor> getBundles()
Get the included bundles- Returns:
- The list of bundles, might be empty
-
getConfigurations
public abstract List<org.apache.sling.feature.Configuration> getConfigurations()
Get the included configurations- Returns:
- The list of configurations, might be empty
-
getParentContentPackage
public abstract ContentPackageDescriptor getParentContentPackage()
Get the parent content package- Returns:
- The parent content package or
null
-
getParentContentPath
public abstract String getParentContentPath()
Get the parent content path- Returns:
- The parent content path or
null
-
isEmbeddedInContentPackage
public boolean isEmbeddedInContentPackage()
Whether this artifact is embedded in a content package- Returns:
true
if embedded.
-
hasEmbeddedArtifacts
public boolean hasEmbeddedArtifacts()
Check whether the package has embedded artifacts- Returns:
true
if the package has embedded artifacts
-
getPackageProperties
public abstract Properties getPackageProperties()
Get the package properties- Returns:
- The package properties
-
toString
public String toString()
- Overrides:
toString
in classDescriptor
-
-