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(MavenProject project, ProjectBuildingRequest buildingRequest, File outputBasedir)

Method Summary

Modifier and Type	Method and Description
AndFilter	filter()
ProjectBuildingRequest	getBuildingRequest()
boolean	includeCompileSources()
boolean	includeTestSources()
File	outputBasedir()
MavenProject	project()
List<MavenProject>	reactorProjects()
SourceResolverConfig	withCompileSources()
SourceResolverConfig	withFilter(AndFilter filter)
SourceResolverConfig	withoutCompileSources()
SourceResolverConfig	withoutTestSources()
SourceResolverConfig	withReactorProjects(List<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(MavenProject project,
                            ProjectBuildingRequest buildingRequest,
                            File outputBasedir)

Parameters:

project - MavenProject

buildingRequest - ProjectBuildingRequest

outputBasedir - The output base directory.

Method Detail

withFilter

public SourceResolverConfig withFilter(AndFilter filter)

Parameters:

filter - AndFilter

Returns:

SourceResolverConfig

withReactorProjects

public SourceResolverConfig withReactorProjects(List<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 MavenProject project()

Returns:

MavenProject

getBuildingRequest

public ProjectBuildingRequest getBuildingRequest()

Returns:

ProjectBuildingRequest

filter

public AndFilter filter()

Returns:

AndFilter

reactorProjects

public List<MavenProject> reactorProjects()

Returns:

list of MavenProject

outputBasedir

public File outputBasedir()

Returns:

outputBasedir

includeCompileSources

public boolean includeCompileSources()

Returns:

compileSourceIncluded

includeTestSources

public boolean includeTestSources()

Returns:

testSourceIncluded