org.apache.maven.api.model

Class Reporting

java.lang.Object

org.apache.maven.api.model.Reporting

All Implemented Interfaces:

Serializable, InputLocationTracker

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class Reporting
extends Object
implements Serializable, InputLocationTracker

Section for management of reports and their configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Reporting.Builder Builder class used to create Reporting instances.

Method Summary

Modifier and Type	Method and Description
String	getExcludeDefaults() If true, then the default reports are not included in the site generation.
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
String	getOutputDirectory() Where to store all of the generated reports.
List<ReportPlugin>	getPlugins() The reporting plugins to use and their configuration.
boolean	isExcludeDefaults()
static Reporting.Builder	newBuilder() Creates a new Reporting builder instance.
static Reporting.Builder	newBuilder(boolean withDefaults) Creates a new Reporting builder instance using default values or not.
static Reporting.Builder	newBuilder(Reporting from) Creates a new Reporting builder instance using the specified object as a basis.
static Reporting.Builder	newBuilder(Reporting from, boolean forceCopy) Creates a new Reporting builder instance using the specified object as a basis.
static Reporting	newInstance() Creates a new Reporting instance.
static Reporting	newInstance(boolean withDefaults) Creates a new Reporting instance using default values or not.
Reporting.Builder	with() Creates a new builder with this object as the basis.
Reporting	withExcludeDefaults(String excludeDefaults) Creates a new Reporting instance using the specified excludeDefaults.
Reporting	withOutputDirectory(String outputDirectory) Creates a new Reporting instance using the specified outputDirectory.
Reporting	withPlugins(Collection<ReportPlugin> plugins) Creates a new Reporting instance using the specified plugins.

Methods inherited from class java.lang.Object

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

Method Detail

getExcludeDefaults

public String getExcludeDefaults()

If true, then the default reports are not included in the site generation. This includes the reports in the "Project Info" menu. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.

Returns:

a String

getOutputDirectory

public String getOutputDirectory()

Where to store all of the generated reports. The default is ${project.build.directory}/site.

Returns:

a String

getPlugins

@Nonnull
public List<ReportPlugin> getPlugins()

The reporting plugins to use and their configuration.

Returns:

a List<ReportPlugin>

getLocation

public InputLocation getLocation(Object key)

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

with

@Nonnull
public Reporting.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

withExcludeDefaults

@Nonnull
public Reporting withExcludeDefaults(String excludeDefaults)

Creates a new Reporting instance using the specified excludeDefaults.

Parameters:

excludeDefaults - the new String to use

Returns:

a Reporting with the specified excludeDefaults

withOutputDirectory

@Nonnull
public Reporting withOutputDirectory(String outputDirectory)

Creates a new Reporting instance using the specified outputDirectory.

Parameters:

outputDirectory - the new String to use

Returns:

a Reporting with the specified outputDirectory

withPlugins

@Nonnull
public Reporting withPlugins(Collection<ReportPlugin> plugins)

Creates a new Reporting instance using the specified plugins.

Parameters:

plugins - the new Collection<ReportPlugin> to use

Returns:

a Reporting with the specified plugins

newInstance

@Nonnull
public static Reporting newInstance()

Creates a new Reporting instance. Equivalent to newInstance( true ).

Returns:

a new Reporting

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static Reporting newInstance(boolean withDefaults)

Creates a new Reporting instance using default values or not. Equivalent to newBuilder( withDefaults ).build().

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new Reporting

newBuilder

@Nonnull
public static Reporting.Builder newBuilder()

Creates a new Reporting builder instance. Equivalent to newBuilder( true ).

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

@Nonnull
public static Reporting.Builder newBuilder(boolean withDefaults)

Creates a new Reporting builder instance using default values or not.

Parameters:

withDefaults - the boolean indicating whether default values should be used

Returns:

a new Builder

newBuilder

@Nonnull
public static Reporting.Builder newBuilder(Reporting from)

Creates a new Reporting builder instance using the specified object as a basis. Equivalent to newBuilder( from, false ).

Parameters:

from - the Reporting instance to use as a basis

Returns:

a new Builder

newBuilder

@Nonnull
public static Reporting.Builder newBuilder(Reporting from,
                                                    boolean forceCopy)

Creates a new Reporting builder instance using the specified object as a basis.

Parameters:

from - the Reporting instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder

isExcludeDefaults

public boolean isExcludeDefaults()