Package org.apache.maven.plugins.javadoc.resolver

Class ResourceResolver

java.lang.Object

org.apache.maven.plugins.javadoc.resolver.ResourceResolver

@Named
@Singleton
public final class ResourceResolver
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager
private static final org.slf4j.Logger	LOGGER
private org.eclipse.aether.RepositorySystem	repoSystem
private static final List<String>	RESOURCE_VALID_CLASSIFIERS
private static final List<String>	SOURCE_VALID_CLASSIFIERS
static final String	SOURCES_CLASSIFIER	The classifier for sources.
static final String	TEST_SOURCES_CLASSIFIER	The classifier for test sources

Constructor Summary

Constructors

Constructor	Description
ResourceResolver()

Method Summary

Modifier and Type	Method	Description
private org.eclipse.aether.artifact.Artifact	createResourceArtifact(org.apache.maven.artifact.Artifact artifact, String classifier, SourceResolverConfig config)
private Collection<Path>	resolveAndUnpack(List<org.eclipse.aether.artifact.Artifact> artifacts, SourceResolverConfig config, List<String> validClassifiers, boolean propagateErrors)
private static List<JavadocBundle>	resolveBundleFromProject(SourceResolverConfig config, org.apache.maven.project.MavenProject project, org.apache.maven.artifact.Artifact artifact)
private List<JavadocBundle>	resolveBundlesFromArtifacts(SourceResolverConfig config, List<org.apache.maven.artifact.Artifact> artifacts)
List<JavadocBundle>	resolveDependencyJavadocBundles(SourceResolverConfig config)
Collection<JavadocModule>	resolveDependencySourcePaths(SourceResolverConfig config)
private JavadocModule	resolveFromArtifact(SourceResolverConfig config, org.apache.maven.artifact.Artifact artifact)
private static Collection<Path>	resolveFromProject(SourceResolverConfig config, org.apache.maven.project.MavenProject reactorProject, org.apache.maven.artifact.Artifact artifact)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

repoSystem

@Inject
private org.eclipse.aether.RepositorySystem repoSystem

archiverManager

@Inject
private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

SOURCES_CLASSIFIER

public static final String SOURCES_CLASSIFIER

The classifier for sources.

See Also:

• Constant Field Values

TEST_SOURCES_CLASSIFIER

public static final String TEST_SOURCES_CLASSIFIER

The classifier for test sources

See Also:

• Constant Field Values

SOURCE_VALID_CLASSIFIERS

private static final List<String> SOURCE_VALID_CLASSIFIERS

RESOURCE_VALID_CLASSIFIERS

private static final List<String> RESOURCE_VALID_CLASSIFIERS

Constructor Details

ResourceResolver

public ResourceResolver()

Method Details

resolveDependencyJavadocBundles

public List<JavadocBundle> resolveDependencyJavadocBundles(SourceResolverConfig config)
                                                    throws IOException

Parameters:

config - SourceResolverConfig

Returns:

list of JavadocBundle.

Throws:

IOException - IOException

resolveDependencySourcePaths

public Collection<JavadocModule> 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 List<JavadocBundle> resolveBundleFromProject(SourceResolverConfig config,
 org.apache.maven.project.MavenProject project,
 org.apache.maven.artifact.Artifact artifact)
                                                     throws IOException

Throws:

IOException

resolveBundlesFromArtifacts

private List<JavadocBundle> resolveBundlesFromArtifacts(SourceResolverConfig config,
 List<org.apache.maven.artifact.Artifact> artifacts)
                                                 throws IOException

Throws:

IOException

resolveFromArtifact

private JavadocModule resolveFromArtifact(SourceResolverConfig config,
 org.apache.maven.artifact.Artifact artifact)
                                   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.eclipse.aether.artifact.Artifact createResourceArtifact(org.apache.maven.artifact.Artifact artifact,
 String classifier,
 SourceResolverConfig config)

resolveAndUnpack

private Collection<Path> resolveAndUnpack(List<org.eclipse.aether.artifact.Artifact> artifacts,
 SourceResolverConfig config,
 List<String> validClassifiers,
 boolean propagateErrors)
                                   throws org.apache.maven.artifact.resolver.ArtifactResolutionException

Parameters:

artifacts - the artifacts to resolve

config - the configuration

validClassifiers -

propagateErrors -

Returns:

list of invalid input: '<'dependencyConflictId, absolutePath>

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException - if an exception occurs

resolveFromProject

private static Collection<Path> resolveFromProject(SourceResolverConfig config,
 org.apache.maven.project.MavenProject reactorProject,
 org.apache.maven.artifact.Artifact artifact)