Class ResourceResolver
- java.lang.Object
-
- org.codehaus.plexus.logging.AbstractLogEnabled
-
- org.apache.maven.plugins.javadoc.resolver.ResourceResolver
-
- All Implemented Interfaces:
org.codehaus.plexus.logging.LogEnabled
@Component(role=ResourceResolver.class) public final class ResourceResolver extends org.codehaus.plexus.logging.AbstractLogEnabled
-
-
Field Summary
Fields Modifier and Type Field Description private org.codehaus.plexus.archiver.manager.ArchiverManager
archiverManager
private org.apache.maven.artifact.factory.ArtifactFactory
artifactFactory
private org.apache.maven.artifact.metadata.ArtifactMetadataSource
artifactMetadataSource
private org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver
dependencyResolver
private org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver
resolver
private static java.util.List<java.lang.String>
RESOURCE_VALID_CLASSIFIERS
private static java.util.List<java.lang.String>
SOURCE_VALID_CLASSIFIERS
static java.lang.String
SOURCES_CLASSIFIER
The classifier for sources.static java.lang.String
TEST_SOURCES_CLASSIFIER
The classifier for test sources
-
Constructor Summary
Constructors Constructor Description ResourceResolver()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private org.apache.maven.artifact.Artifact
createResourceArtifact(org.apache.maven.artifact.Artifact artifact, java.lang.String classifier, SourceResolverConfig config)
private static java.lang.String
key(java.lang.String gid, java.lang.String aid)
private java.util.Collection<java.util.Map.Entry<java.lang.String,java.nio.file.Path>>
resolveAndUnpack(java.util.List<org.apache.maven.artifact.Artifact> artifacts, SourceResolverConfig config, java.util.List<java.lang.String> validClassifiers, boolean propagateErrors)
private static java.util.List<JavadocBundle>
resolveBundleFromProject(SourceResolverConfig config, org.apache.maven.project.MavenProject project, org.apache.maven.artifact.Artifact artifact)
private java.util.List<JavadocBundle>
resolveBundlesFromArtifacts(SourceResolverConfig config, java.util.List<org.apache.maven.artifact.Artifact> artifacts)
java.util.List<JavadocBundle>
resolveDependencyJavadocBundles(SourceResolverConfig config)
java.util.Map<java.lang.String,java.util.Collection<java.nio.file.Path>>
resolveDependencySourcePaths(SourceResolverConfig config)
private java.util.Collection<java.util.Map.Entry<java.lang.String,java.nio.file.Path>>
resolveFromArtifacts(SourceResolverConfig config, java.util.List<org.apache.maven.artifact.Artifact> artifacts)
private static java.util.Collection<java.nio.file.Path>
resolveFromProject(SourceResolverConfig config, org.apache.maven.project.MavenProject reactorProject, org.apache.maven.artifact.Artifact artifact)
-
-
-
Field Detail
-
artifactFactory
@Requirement private org.apache.maven.artifact.factory.ArtifactFactory artifactFactory
-
resolver
@Requirement private org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver resolver
-
dependencyResolver
@Requirement private org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolver dependencyResolver
-
artifactMetadataSource
@Requirement private org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource
-
archiverManager
@Requirement private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager
-
SOURCES_CLASSIFIER
public static final java.lang.String SOURCES_CLASSIFIER
The classifier for sources.- See Also:
- Constant Field Values
-
TEST_SOURCES_CLASSIFIER
public static final java.lang.String TEST_SOURCES_CLASSIFIER
The classifier for test sources- See Also:
- Constant Field Values
-
SOURCE_VALID_CLASSIFIERS
private static final java.util.List<java.lang.String> SOURCE_VALID_CLASSIFIERS
-
RESOURCE_VALID_CLASSIFIERS
private static final java.util.List<java.lang.String> RESOURCE_VALID_CLASSIFIERS
-
-
Method Detail
-
resolveDependencyJavadocBundles
public java.util.List<JavadocBundle> resolveDependencyJavadocBundles(SourceResolverConfig config) throws java.io.IOException
- Parameters:
config
-SourceResolverConfig
- Returns:
- list of
JavadocBundle
. - Throws:
java.io.IOException
-IOException
-
resolveDependencySourcePaths
public java.util.Map<java.lang.String,java.util.Collection<java.nio.file.Path>> resolveDependencySourcePaths(SourceResolverConfig config) throws org.apache.maven.artifact.resolver.ArtifactResolutionException, org.apache.maven.artifact.resolver.ArtifactNotFoundException
- Parameters:
config
-SourceResolverConfig
- Returns:
- The list of resolved dependencies.
- Throws:
org.apache.maven.artifact.resolver.ArtifactResolutionException
-ArtifactResolutionException
org.apache.maven.artifact.resolver.ArtifactNotFoundException
-ArtifactNotFoundException
-
resolveBundleFromProject
private static java.util.List<JavadocBundle> resolveBundleFromProject(SourceResolverConfig config, org.apache.maven.project.MavenProject project, org.apache.maven.artifact.Artifact artifact) throws java.io.IOException
- Throws:
java.io.IOException
-
resolveBundlesFromArtifacts
private java.util.List<JavadocBundle> resolveBundlesFromArtifacts(SourceResolverConfig config, java.util.List<org.apache.maven.artifact.Artifact> artifacts) throws java.io.IOException
- Throws:
java.io.IOException
-
resolveFromArtifacts
private java.util.Collection<java.util.Map.Entry<java.lang.String,java.nio.file.Path>> resolveFromArtifacts(SourceResolverConfig config, java.util.List<org.apache.maven.artifact.Artifact> artifacts) throws org.apache.maven.artifact.resolver.ArtifactResolutionException, org.apache.maven.artifact.resolver.ArtifactNotFoundException
- Throws:
org.apache.maven.artifact.resolver.ArtifactResolutionException
org.apache.maven.artifact.resolver.ArtifactNotFoundException
-
createResourceArtifact
private org.apache.maven.artifact.Artifact createResourceArtifact(org.apache.maven.artifact.Artifact artifact, java.lang.String classifier, SourceResolverConfig config)
-
resolveAndUnpack
private java.util.Collection<java.util.Map.Entry<java.lang.String,java.nio.file.Path>> resolveAndUnpack(java.util.List<org.apache.maven.artifact.Artifact> artifacts, SourceResolverConfig config, java.util.List<java.lang.String> validClassifiers, boolean propagateErrors) throws org.apache.maven.artifact.resolver.ArtifactResolutionException, org.apache.maven.artifact.resolver.ArtifactNotFoundException
- Parameters:
artifacts
- the artifacts to resolveconfig
- the configurationvalidClassifiers
-propagateErrors
-- Returns:
- list of
- Throws:
org.apache.maven.artifact.resolver.ArtifactResolutionException
- if an exception occursorg.apache.maven.artifact.resolver.ArtifactNotFoundException
- if an exception occurs
-
resolveFromProject
private static java.util.Collection<java.nio.file.Path> resolveFromProject(SourceResolverConfig config, org.apache.maven.project.MavenProject reactorProject, org.apache.maven.artifact.Artifact artifact)
-
key
private static java.lang.String key(java.lang.String gid, java.lang.String aid)
-
-