Class ApisJarContext
java.lang.Object
org.apache.sling.feature.maven.mojos.apis.ApisJarContext
Context for creating the api jars
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Information about a single artifact (bundle) taking part in the api generation. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddArtifactInfo
(org.apache.sling.feature.Artifact artifact) void
addJavadocClasspath
(org.apache.sling.feature.ArtifactId artifactId, String classpath) boolean
findDependencyArtifact
(org.apache.maven.plugin.logging.Log log, ApisJarContext.ArtifactInfo info) Check if all dependency artifacts can be foundgetArtifactInfo
(org.apache.sling.feature.ArtifactId artifactId) getArtifactInfos
(String regionName, boolean omitDependencyArtifacts) org.apache.sling.feature.Feature
org.apache.sling.feature.ArtifactId
Map<org.apache.sling.feature.ArtifactId,
org.apache.maven.model.Model> void
setJavadocDir
(File javadocDir)
-
Constructor Details
-
ApisJarContext
public ApisJarContext(File mainDir, org.apache.sling.feature.Feature feature) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-
-
Method Details
-
getConfig
-
getFeatureId
public org.apache.sling.feature.ArtifactId getFeatureId() -
getFeature
public org.apache.sling.feature.Feature getFeature() -
getDeflatedBinDir
-
getDeflatedSourcesDir
-
getCheckedOutSourcesDir
-
addJavadocClasspath
-
getJavadocClasspath
-
getJavadocDir
-
setJavadocDir
-
getPackagesWithoutJavaClasses
-
getPackagesWithoutSources
-
addArtifactInfo
-
getArtifactInfo
-
getArtifactInfos
-
getModelCache
-
getArtifactInfos
public Collection<ApisJarContext.ArtifactInfo> getArtifactInfos(String regionName, boolean omitDependencyArtifacts) -
findDependencyArtifact
public boolean findDependencyArtifact(org.apache.maven.plugin.logging.Log log, ApisJarContext.ArtifactInfo info) throws org.apache.maven.plugin.MojoExecutionException Check if all dependency artifacts can be found- Parameters:
log
- The loggerinfo
- The artifact info- Returns:
true
if all artifacts are publically available- Throws:
org.apache.maven.plugin.MojoExecutionException
- If an incorrect configuration is found
-