org.apache.maven.plugin.lifecycle

Class Phase

java.lang.Object

org.apache.maven.plugin.lifecycle.Phase

All Implemented Interfaces:

Serializable

@Generated
 @ThreadSafe
 @Immutable
public class Phase
extends Object
implements Serializable

A phase mapping definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
org.apache.maven.api.xml.Dom	getConfiguration() Configuration to pass to all goals run in this phase.
List<Execution>	getExecutions() The goals to execute within the phase.
String	getId() The ID of this phase, e.g., generate-sources.
static Phase.Builder	newBuilder() Creates a new Phase builder instance.
static Phase.Builder	newBuilder(boolean withDefaults) Creates a new Phase builder instance using default values or not.
static Phase.Builder	newBuilder(Phase from) Creates a new Phase builder instance using the specified object as a basis.
static Phase.Builder	newBuilder(Phase from, boolean forceCopy) Creates a new Phase builder instance using the specified object as a basis.
static Phase	newInstance() Creates a new Phase instance.
static Phase	newInstance(boolean withDefaults) Creates a new Phase instance using default values or not.
Phase.Builder	with() Creates a new builder with this object as the basis.
Phase	withConfiguration(org.apache.maven.api.xml.Dom configuration) Creates a new Phase instance using the specified configuration.
Phase	withExecutions(Collection<Execution> executions) Creates a new Phase instance using the specified executions.
Phase	withId(String id) Creates a new Phase instance using the specified id.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

The ID of this phase, e.g., generate-sources.

getExecutions

@Nonnull
public List<Execution> getExecutions()

The goals to execute within the phase.

getConfiguration

public org.apache.maven.api.xml.Dom getConfiguration()

Configuration to pass to all goals run in this phase.

with

@Nonnull
public Phase.Builder with()

Creates a new builder with this object as the basis.

withId

@Nonnull
public Phase withId(String id)

Creates a new Phase instance using the specified id.

withExecutions

@Nonnull
public Phase withExecutions(Collection<Execution> executions)

Creates a new Phase instance using the specified executions.

withConfiguration

@Nonnull
public Phase withConfiguration(org.apache.maven.api.xml.Dom configuration)

Creates a new Phase instance using the specified configuration.

newInstance

@Nonnull
public static Phase newInstance()

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

See Also:

newInstance(boolean)

newInstance

@Nonnull
public static Phase newInstance(boolean withDefaults)

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

newBuilder

@Nonnull
public static Phase.Builder newBuilder()

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

See Also:

newBuilder(boolean)

newBuilder

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

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

newBuilder

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

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

newBuilder

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

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