Class AfterLink
java.lang.Object
org.apache.maven.api.plugin.descriptor.AfterLink
- All Implemented Interfaces:
Serializable
@Experimental
@Generated
@ThreadSafe
@Immutable
public class AfterLink
extends Object
implements Serializable
A lifecycle ordering constraint from an
@After annotation on a Mojo class.
Specifies that the Mojo's bound phase should execute after a given target phase,
with a pointer type controlling how the ordering applies across project boundaries.- Since:
- 4.0.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder class used to create AfterLink instances. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAfterLink(AfterLink.Builder builder) Constructor for this class, to be called from its subclasses andAfterLink.Builder. -
Method Summary
Modifier and TypeMethodDescriptiongetPhase()The target phase name that this Mojo should run after.getScope()The dependency scope, only meaningful when type isDEPENDENCIES.getType()The type of pointer:PROJECT(same-project phase ordering),DEPENDENCIES(cross-project dependency ordering), orCHILDREN(parent-child module ordering).static AfterLink.BuilderCreates a newAfterLinkbuilder instance.static AfterLink.BuildernewBuilder(boolean withDefaults) Creates a newAfterLinkbuilder instance using default values or not.static AfterLink.BuildernewBuilder(AfterLink from) Creates a newAfterLinkbuilder instance using the specified object as a basis.static AfterLink.BuildernewBuilder(AfterLink from, boolean forceCopy) Creates a newAfterLinkbuilder instance using the specified object as a basis.static AfterLinkCreates a newAfterLinkinstance.static AfterLinknewInstance(boolean withDefaults) Creates a newAfterLinkinstance using default values or not.with()Creates a new builder with this object as the basis.Creates a newAfterLinkinstance using the specified phase.Creates a newAfterLinkinstance using the specified scope.Creates a newAfterLinkinstance using the specified type.
-
Constructor Details
-
AfterLink
Constructor for this class, to be called from its subclasses andAfterLink.Builder.- See Also:
-
-
Method Details
-
getPhase
The target phase name that this Mojo should run after.- Returns:
- a
String
-
getType
The type of pointer:PROJECT(same-project phase ordering),DEPENDENCIES(cross-project dependency ordering), orCHILDREN(parent-child module ordering).- Returns:
- a
String
-
getScope
The dependency scope, only meaningful when type isDEPENDENCIES. Examples:compile,runtime,test.- Returns:
- a
String
-
with
Creates a new builder with this object as the basis.- Returns:
- a
Builder
-
withPhase
Creates a newAfterLinkinstance using the specified phase.- Parameters:
phase- the newStringto use- Returns:
- a
AfterLinkwith the specified phase
-
withType
Creates a newAfterLinkinstance using the specified type.- Parameters:
type- the newStringto use- Returns:
- a
AfterLinkwith the specified type
-
withScope
Creates a newAfterLinkinstance using the specified scope.- Parameters:
scope- the newStringto use- Returns:
- a
AfterLinkwith the specified scope
-
newInstance
Creates a newAfterLinkinstance. Equivalent tonewInstance(true).- Returns:
- a new
AfterLink - See Also:
-
newInstance
Creates a newAfterLinkinstance using default values or not. Equivalent tonewBuilder(withDefaults).build().- Parameters:
withDefaults- the boolean indicating whether default values should be used- Returns:
- a new
AfterLink
-
newBuilder
Creates a newAfterLinkbuilder instance. Equivalent tonewBuilder(true).- Returns:
- a new
Builder - See Also:
-
newBuilder
Creates a newAfterLinkbuilder instance using default values or not.- Parameters:
withDefaults- the boolean indicating whether default values should be used- Returns:
- a new
Builder
-
newBuilder
Creates a newAfterLinkbuilder instance using the specified object as a basis. Equivalent tonewBuilder(from, false).- Parameters:
from- theAfterLinkinstance to use as a basis- Returns:
- a new
Builder
-
newBuilder
Creates a newAfterLinkbuilder instance using the specified object as a basis.- Parameters:
from- theAfterLinkinstance to use as a basisforceCopy- the boolean indicating if a copy should be forced- Returns:
- a new
Builder
-