Package org.apache.maven.api.plugin.descriptor.lifecycle

Class LifecycleConfiguration

java.lang.Object

org.apache.maven.api.plugin.descriptor.lifecycle.LifecycleConfiguration

All Implemented Interfaces:

Serializable

@Experimental
@Generated
@ThreadSafe
@Immutable
public class LifecycleConfiguration
extends Object
implements Serializable

Root element of the lifecycle.xml file.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LifecycleConfiguration(LifecycleConfiguration.Builder builder)	Constructor for this class, to be called from its subclasses and LifecycleConfiguration.Builder.

Method Summary

Modifier and Type	Method	Description
List<Lifecycle>	getLifecycles()
String	getModelEncoding()
String	getNamespaceUri()
static LifecycleConfiguration.Builder	newBuilder()	Creates a new LifecycleConfiguration builder instance.
static LifecycleConfiguration.Builder	newBuilder(boolean withDefaults)	Creates a new LifecycleConfiguration builder instance using default values or not.
static LifecycleConfiguration.Builder	newBuilder(LifecycleConfiguration from)	Creates a new LifecycleConfiguration builder instance using the specified object as a basis.
static LifecycleConfiguration.Builder	newBuilder(LifecycleConfiguration from, boolean forceCopy)	Creates a new LifecycleConfiguration builder instance using the specified object as a basis.
static LifecycleConfiguration	newInstance()	Creates a new LifecycleConfiguration instance.
static LifecycleConfiguration	newInstance(boolean withDefaults)	Creates a new LifecycleConfiguration instance using default values or not.
LifecycleConfiguration.Builder	with()	Creates a new builder with this object as the basis.
LifecycleConfiguration	withLifecycles(Collection<Lifecycle> lifecycles)	Creates a new LifecycleConfiguration instance using the specified lifecycles.

Methods inherited from class java.lang.Object

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

Constructor Details

LifecycleConfiguration

protected LifecycleConfiguration(LifecycleConfiguration.Builder builder)

Constructor for this class, to be called from its subclasses and LifecycleConfiguration.Builder.

See Also:

• LifecycleConfiguration.Builder.build()

Method Details

getNamespaceUri

public String getNamespaceUri()

getModelEncoding

public String getModelEncoding()

getLifecycles

@Nonnull
public List<Lifecycle> getLifecycles()

Returns:

a List<Lifecycle>

with

@Nonnull
public LifecycleConfiguration.Builder with()

Creates a new builder with this object as the basis.

Returns:

a Builder

withLifecycles

@Nonnull
public LifecycleConfiguration withLifecycles(Collection<Lifecycle> lifecycles)

Creates a new LifecycleConfiguration instance using the specified lifecycles.

Parameters:

lifecycles - the new Collection<Lifecycle> to use

Returns:

a LifecycleConfiguration with the specified lifecycles

newInstance

@Nonnull
public static LifecycleConfiguration newInstance()

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

Returns:

a new LifecycleConfiguration

See Also:

• newInstance(boolean)

newInstance

@Nonnull
public static LifecycleConfiguration newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static LifecycleConfiguration.Builder newBuilder()

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

Returns:

a new Builder

See Also:

• newBuilder(boolean)

newBuilder

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

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

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

Parameters:

from - the LifecycleConfiguration instance to use as a basis

Returns:

a new Builder

newBuilder

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

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

Parameters:

from - the LifecycleConfiguration instance to use as a basis

forceCopy - the boolean indicating if a copy should be forced

Returns:

a new Builder