Class ApisJarContext
java.lang.Object
org.apache.sling.feature.maven.mojos.apis.ApisJarContext
Context for creating the api jars
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classInformation about a single artifact (bundle) taking part in the api generation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddArtifactInfo(org.apache.sling.feature.Artifact artifact) voidaddJavadocClasspath(org.apache.sling.feature.ArtifactId artifactId, String classpath) booleanfindDependencyArtifact(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.Featureorg.apache.sling.feature.ArtifactIdMap<org.apache.sling.feature.ArtifactId,org.apache.maven.model.Model> voidsetJavadocDir(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:
trueif all artifacts are publically available- Throws:
org.apache.maven.plugin.MojoExecutionException- If an incorrect configuration is found
-