Class ApisJarContext.ArtifactInfo
- java.lang.Object
-
- org.apache.sling.feature.maven.mojos.apis.ApisJarContext.ArtifactInfo
-
- Enclosing class:
- ApisJarContext
public static final class ApisJarContext.ArtifactInfo extends Object
Information about a single artifact (bundle) taking part in the api generation.
-
-
Constructor Summary
Constructors Constructor Description ArtifactInfo(org.apache.sling.feature.Artifact artifact)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSourceInfo(String connection)
void
addSourceInfo(org.apache.sling.feature.ArtifactId id)
org.apache.sling.feature.Artifact
getArtifact()
File
getBinDirectory()
List<org.apache.sling.feature.ArtifactId>
getDependencyArtifacts()
Get the dependency artifacts IfApisUtil#API_IDS
is provided as metadata for the artifact, the value is used as a list of artifacts IfApisUtil#SCM_IDS
is provided as metadata for the artifact, the value is used as a list of artifacts.org.apache.sling.feature.ArtifactId
getId()
Set<File>
getIncludedResources()
List<org.apache.maven.model.License>
getLicenses()
Set<String>
getNodeTypes()
Get all node types from this artifactFile
getSourceDirectory()
Set<String>
getSources()
String[]
getUsedExportedPackageIncludes()
String[]
getUsedExportedPackageIncludes(org.apache.sling.feature.extension.apiregions.api.ApiRegion region)
Set<String>
getUsedExportedPackages()
Set<org.apache.felix.utils.manifest.Clause>
getUsedExportedPackages(org.apache.sling.feature.extension.apiregions.api.ApiRegion region)
boolean
isUseAsDependencyPerRegion(org.apache.sling.feature.extension.apiregions.api.ApiRegion region)
void
setBinDirectory(File binDirectory)
void
setLicenses(List<org.apache.maven.model.License> licenses)
void
setSourceDirectory(File sourceDirectory)
void
setUsedExportedPackages(Set<String> usedExportedPackages)
void
setUsedExportedPackages(org.apache.sling.feature.extension.apiregions.api.ApiRegion region, Set<org.apache.felix.utils.manifest.Clause> usedExportedPackages, boolean useAsDependency)
-
-
-
Method Detail
-
getId
public org.apache.sling.feature.ArtifactId getId()
-
getArtifact
public org.apache.sling.feature.Artifact getArtifact()
-
getBinDirectory
public File getBinDirectory()
-
setBinDirectory
public void setBinDirectory(File binDirectory)
-
getSourceDirectory
public File getSourceDirectory()
-
setSourceDirectory
public void setSourceDirectory(File sourceDirectory)
-
getUsedExportedPackageIncludes
public String[] getUsedExportedPackageIncludes()
-
getUsedExportedPackages
public Set<org.apache.felix.utils.manifest.Clause> getUsedExportedPackages(org.apache.sling.feature.extension.apiregions.api.ApiRegion region)
-
setUsedExportedPackages
public void setUsedExportedPackages(org.apache.sling.feature.extension.apiregions.api.ApiRegion region, Set<org.apache.felix.utils.manifest.Clause> usedExportedPackages, boolean useAsDependency)
-
getUsedExportedPackageIncludes
public String[] getUsedExportedPackageIncludes(org.apache.sling.feature.extension.apiregions.api.ApiRegion region)
-
isUseAsDependencyPerRegion
public boolean isUseAsDependencyPerRegion(org.apache.sling.feature.extension.apiregions.api.ApiRegion region)
-
getNodeTypes
public Set<String> getNodeTypes()
Get all node types from this artifact- Returns:
- The set of node types, might be empty
-
getLicenses
public List<org.apache.maven.model.License> getLicenses()
-
setLicenses
public void setLicenses(List<org.apache.maven.model.License> licenses)
-
getDependencyArtifacts
public List<org.apache.sling.feature.ArtifactId> getDependencyArtifacts() throws org.apache.maven.plugin.MojoExecutionException
Get the dependency artifacts- If
ApisUtil#API_IDS
is provided as metadata for the artifact, the value is used as a list of artifacts - If
ApisUtil#SCM_IDS
is provided as metadata for the artifact, the value is used as a list of artifacts. The artifacts must have a classifier set. The classifier is removed and then the artifacts are used - The artifact itself is used
- Returns:
- The list of dependency artifacts
- Throws:
org.apache.maven.plugin.MojoExecutionException
- If
-
addSourceInfo
public void addSourceInfo(org.apache.sling.feature.ArtifactId id)
-
addSourceInfo
public void addSourceInfo(String connection)
-
-