org.apache.maven.api.model

Class PluginManagement

java.lang.Object

org.apache.maven.api.model.PluginContainer

org.apache.maven.api.model.PluginManagement

All Implemented Interfaces:

Serializable, InputLocationTracker

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

Section for management of default plugin information for use in a group of POMs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
InputLocation	getLocation(Object key) Gets the location of the specified field in the input source.
static PluginManagement.Builder	newBuilder() Creates a new PluginManagement builder instance.
static PluginManagement.Builder	newBuilder(boolean withDefaults) Creates a new PluginManagement builder instance using default values or not.
static PluginManagement.Builder	newBuilder(PluginManagement from) Creates a new PluginManagement builder instance using the specified object as a basis.
static PluginManagement.Builder	newBuilder(PluginManagement from, boolean forceCopy) Creates a new PluginManagement builder instance using the specified object as a basis.
static PluginManagement	newInstance() Creates a new PluginManagement instance.
static PluginManagement	newInstance(boolean withDefaults) Creates a new PluginManagement instance using default values or not.
PluginManagement.Builder	with() Creates a new builder with this object as the basis.
PluginManagement	withPlugins(Collection<Plugin> plugins) Creates a new PluginManagement 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

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 PluginManagement.Builder with()

Creates a new builder with this object as the basis.

Overrides:

with in class PluginContainer

Returns:

a Builder

withPlugins

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

Creates a new PluginManagement instance using the specified plugins.

Overrides:

withPlugins in class PluginContainer

Parameters:

plugins - the new Collection<Plugin> to use

Returns:

a PluginManagement with the specified plugins

newInstance

@Nonnull
public static PluginManagement newInstance()

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

Returns:

a new PluginManagement

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static PluginManagement newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static PluginManagement.Builder newBuilder()

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

Returns:

a new Builder

See Also:

newBuilder(boolean)

newBuilder

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

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

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

Parameters:

from - the PluginManagement instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the PluginManagement instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder