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

Class SourceResolverConfig

java.lang.Object

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

public class SourceResolverConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.maven.project.ProjectBuildingRequest	buildingRequest
private boolean	compileSourceIncluded
private org.apache.maven.shared.artifact.filter.resolve.AndFilter	filter
private final File	outputBasedir
private final org.apache.maven.project.MavenProject	project
private List<org.apache.maven.project.MavenProject>	reactorProjects
private boolean	testSourceIncluded

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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

Field Details

buildingRequest

private org.apache.maven.project.ProjectBuildingRequest buildingRequest

project

private final org.apache.maven.project.MavenProject project

filter

private org.apache.maven.shared.artifact.filter.resolve.AndFilter filter

reactorProjects

private List<org.apache.maven.project.MavenProject> reactorProjects

outputBasedir

private final File outputBasedir

compileSourceIncluded

private boolean compileSourceIncluded

testSourceIncluded

private boolean testSourceIncluded

Constructor Details

SourceResolverConfig

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

Parameters:

project - MavenProject

buildingRequest - ProjectBuildingRequest

outputBasedir - The output base directory.

Method Details

withFilter

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

Parameters:

filter - AndFilter

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:

AndFilter

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