org.apache.maven.api.model

Class PluginConfiguration

java.lang.Object

org.apache.maven.api.model.PluginContainer

org.apache.maven.api.model.PluginConfiguration

All Implemented Interfaces:

Serializable, InputLocationTracker

Direct Known Subclasses:

BuildBase

@Experimental
 @Generated
 @ThreadSafe
 @Immutable
public class PluginConfiguration
extends PluginContainer
implements Serializable, InputLocationTracker

Contains the plugins management informations for the project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
PluginManagement	getPluginManagement() Default plugin information to be made available for reference by projects derived from this one.
static PluginConfiguration.Builder	newBuilder() Creates a new PluginConfiguration builder instance.
static PluginConfiguration.Builder	newBuilder(boolean withDefaults) Creates a new PluginConfiguration builder instance using default values or not.
static PluginConfiguration.Builder	newBuilder(PluginConfiguration from) Creates a new PluginConfiguration builder instance using the specified object as a basis.
static PluginConfiguration.Builder	newBuilder(PluginConfiguration from, boolean forceCopy) Creates a new PluginConfiguration builder instance using the specified object as a basis.
static PluginConfiguration	newInstance() Creates a new PluginConfiguration instance.
static PluginConfiguration	newInstance(boolean withDefaults) Creates a new PluginConfiguration instance using default values or not.
PluginConfiguration.Builder	with() Creates a new builder with this object as the basis.
PluginConfiguration	withPluginManagement(PluginManagement pluginManagement) Creates a new PluginConfiguration instance using the specified pluginManagement.
PluginConfiguration	withPlugins(Collection<Plugin> plugins) Creates a new PluginConfiguration instance using the specified plugins.

Methods inherited from class org.apache.maven.api.model.PluginContainer

flushPluginMap, getPlugins, getPluginsAsMap, newBuilder, newBuilder

Methods inherited from class java.lang.Object

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

Method Detail

getPluginManagement

public PluginManagement getPluginManagement()

Default plugin information to be made available for reference by projects derived from this one. This plugin configuration will not be resolved or bound to the lifecycle unless referenced. Any local configuration for a given plugin will override the plugin's entire definition here.

Returns:

a PluginManagement

getLocation

public InputLocation getLocation(Object key)

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

Specified by:

getLocation in interface InputLocationTracker

Overrides:

getLocation in class PluginContainer

with

@Nonnull
public PluginConfiguration.Builder with()

Creates a new builder with this object as the basis.

Overrides:

with in class PluginContainer

Returns:

a Builder

withPlugins

@Nonnull
public PluginConfiguration withPlugins(Collection<Plugin> plugins)

Creates a new PluginConfiguration instance using the specified plugins.

Overrides:

withPlugins in class PluginContainer

Parameters:

plugins - the new Collection<Plugin> to use

Returns:

a PluginConfiguration with the specified plugins

withPluginManagement

@Nonnull
public PluginConfiguration withPluginManagement(PluginManagement pluginManagement)

Creates a new PluginConfiguration instance using the specified pluginManagement.

Parameters:

pluginManagement - the new PluginManagement to use

Returns:

a PluginConfiguration with the specified pluginManagement

newInstance

@Nonnull
public static PluginConfiguration newInstance()

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

Returns:

a new PluginConfiguration

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static PluginConfiguration newInstance(boolean withDefaults)

Creates a new PluginConfiguration 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 PluginConfiguration

newBuilder

@Nonnull
public static PluginConfiguration.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

Creates a new PluginConfiguration 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 PluginConfiguration.Builder newBuilder(PluginConfiguration from)

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

Parameters:

from - the PluginConfiguration instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the PluginConfiguration instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder