org.apache.maven.plugins.javadoc.resolver

Class SourceResolverConfig

java.lang.Object

org.apache.maven.plugins.javadoc.resolver.SourceResolverConfig

public class SourceResolverConfig
extends Object

Constructor Summary

Constructors

Constructor and Description
SourceResolverConfig(org.apache.maven.project.MavenProject project, org.apache.maven.project.ProjectBuildingRequest buildingRequest, File outputBasedir)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.maven.shared.artifact.filter.resolve.AndFilter	filter()
org.apache.maven.project.ProjectBuildingRequest	getBuildingRequest()
boolean	includeCompileSources()
boolean	includeTestSources()
File	outputBasedir()
org.apache.maven.project.MavenProject	project()
List<org.apache.maven.project.MavenProject>	reactorProjects()
SourceResolverConfig	withCompileSources()
SourceResolverConfig	withFilter(org.apache.maven.shared.artifact.filter.resolve.AndFilter filter)
SourceResolverConfig	withoutCompileSources()
SourceResolverConfig	withoutTestSources()
SourceResolverConfig	withReactorProjects(List<org.apache.maven.project.MavenProject> reactorProjects)
SourceResolverConfig	withTestSources()

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceResolverConfig

public SourceResolverConfig(org.apache.maven.project.MavenProject project,
                    org.apache.maven.project.ProjectBuildingRequest buildingRequest,
                    File outputBasedir)

Parameters:

project - MavenProject

buoildingRequest - ProjectBuildingRequest

outputBasedir - The output base directory.

Method Detail

withFilter

public SourceResolverConfig withFilter(org.apache.maven.shared.artifact.filter.resolve.AndFilter filter)

Parameters:

filter - ArtifactFilter

Returns:

SourceResolverConfig

withReactorProjects

public SourceResolverConfig withReactorProjects(List<org.apache.maven.project.MavenProject> reactorProjects)

Parameters:

reactorProjects - The list of reactor projects.

Returns:

SourceResolverConfig

withCompileSources

public SourceResolverConfig withCompileSources()

Returns:

SourceResolverConfig

withoutCompileSources

public SourceResolverConfig withoutCompileSources()

Returns:

SourceResolverConfig

withTestSources

public SourceResolverConfig withTestSources()

Returns:

SourceResolverConfig

withoutTestSources

public SourceResolverConfig withoutTestSources()

Returns:

SourceResolverConfig

project

public org.apache.maven.project.MavenProject project()

Returns:

MavenProject

getBuildingRequest

public org.apache.maven.project.ProjectBuildingRequest getBuildingRequest()

Returns:

ProjectBuildingRequest

filter

public org.apache.maven.shared.artifact.filter.resolve.AndFilter filter()

Returns:

TransformableFilter

reactorProjects

public List<org.apache.maven.project.MavenProject> reactorProjects()

Returns:

list of MavenProject

outputBasedir

public File outputBasedir()

Returns:

outputBasedir

includeCompileSources

public boolean includeCompileSources()

Returns:

compileSourceIncluded

includeTestSources

public boolean includeTestSources()

Returns:

testSourceIncluded