Class ApisUtil
java.lang.Object
org.apache.sling.feature.maven.mojos.apis.ApisUtil
Context for creating the api jars
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringAlternative IDs for artifact dependencies.static final StringIgnore packages for api generationstatic final StringAdditional artifacts for javadoc classpathstatic final StringLinks for javadocs.static final StringAlternative classifier for the source artifact.static final StringAlternative SCM encoding, default is UTF-8static final StringAlternative IDS to a source artifact.static final StringAlternative SCM location.static final StringTag for source when using SCM info -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuildJavadocClasspath(org.apache.maven.plugin.logging.Log log, org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.execution.MavenSession mavenSession, org.apache.sling.feature.ArtifactId artifactId) static List<org.apache.sling.feature.Artifact> getAdditionalJavadocArtifacts(ApisJarContext context, String regionName) Get all artifacts from the configured extensionsstatic List<org.apache.sling.feature.ArtifactId> getApiIds(org.apache.sling.feature.Artifact artifact) getIgnoredPackages(org.apache.sling.feature.Artifact bundle) static Collection<String> getJavadocClassPath(org.apache.maven.plugin.logging.Log log, org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.execution.MavenSession mavenSession, ApisJarContext ctx, String regionName) Build the classpath for javadocgetJavadocLinks(org.apache.sling.feature.Artifact artifact) static voidgetPackageList(String javadocUrl, Set<String> linkedPackages, Map<String, Set<String>> linkedPackagesMap) getPackages(ApisJarContext ctx, File file, String extension) Get all packages contained in the archivegetProcessors(boolean includeProviderTypeResource) Get the list of processorsstatic List<org.apache.sling.feature.ArtifactId> getSourceIds(org.apache.sling.feature.Artifact artifact) static voidvalidateSourceInfo(org.apache.sling.feature.Artifact artifact) Validate that only one source metadata is setstatic voidwriteSourceReport(boolean write, org.apache.maven.plugin.logging.Log log, File reportFile, List<ApisJarContext.ArtifactInfo> infos)
-
Field Details
-
SCM_TAG
-
SCM_LOCATION
-
SCM_ENCODING
-
API_IDS
-
SCM_IDS
-
SCM_CLASSIFIER
-
JAVADOC_LINKS
-
JAVADOC_CLASSPATH
-
IGNORE_PACKAGES
-
-
Constructor Details
-
ApisUtil
public ApisUtil()
-
-
Method Details
-
getSourceIds
public static List<org.apache.sling.feature.ArtifactId> getSourceIds(org.apache.sling.feature.Artifact artifact) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-
getApiIds
public static List<org.apache.sling.feature.ArtifactId> getApiIds(org.apache.sling.feature.Artifact artifact) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-
getJavadocLinks
-
getPackageList
-
getIgnoredPackages
-
validateSourceInfo
public static void validateSourceInfo(org.apache.sling.feature.Artifact artifact) throws org.apache.maven.plugin.MojoExecutionException Validate that only one source metadata is set- Parameters:
artifact- The artifact to check- Throws:
org.apache.maven.plugin.MojoExecutionException- If metadata information is invalid
-
getJavadocClassPath
public static Collection<String> getJavadocClassPath(org.apache.maven.plugin.logging.Log log, org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.execution.MavenSession mavenSession, ApisJarContext ctx, String regionName) throws org.apache.maven.plugin.MojoExecutionException Build the classpath for javadoc- Parameters:
log- The log to userepositorySystem- The repository system to usemavenSession- The maven session to usectx- The Apis Jar Context to useregionName- The region name to use- Returns:
- The computed javadoc classpath
- Throws:
org.apache.maven.plugin.MojoExecutionException- When an invalid artifact ID is found
-
buildJavadocClasspath
public static Map<org.apache.sling.feature.ArtifactId, String> buildJavadocClasspath(org.apache.maven.plugin.logging.Log log, org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.execution.MavenSession mavenSession, org.apache.sling.feature.ArtifactId artifactId) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-
getProcessors
-
getPackages
public static Map.Entry<Set<String>, Set<String>> getPackages(ApisJarContext ctx, File file, String extension) throws org.apache.maven.plugin.MojoExecutionException Get all packages contained in the archive- Parameters:
ctx- The generation contextfile- The archive to checkextension- The extension to check for- Returns:
- A tuple of packages containing files with the extension and packages with files not having the extension
- Throws:
org.apache.maven.plugin.MojoExecutionException- If processing fails
-
getAdditionalJavadocArtifacts
public static List<org.apache.sling.feature.Artifact> getAdditionalJavadocArtifacts(ApisJarContext context, String regionName) throws org.apache.maven.plugin.MojoExecutionException Get all artifacts from the configured extensions- Parameters:
context- The contextregionName- The name of the region- Returns:
- A list of artifacts, might be empty
- Throws:
org.apache.maven.plugin.MojoExecutionException- If processing fails or configuration is invalid
-
writeSourceReport
public static void writeSourceReport(boolean write, org.apache.maven.plugin.logging.Log log, File reportFile, List<ApisJarContext.ArtifactInfo> infos) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-