[MNG-8541] Support throwing Exception from Mojo#execute#2066
Merged
gnodet merged 2 commits intoapache:masterfrom Jan 29, 2025
Merged
[MNG-8541] Support throwing Exception from Mojo#execute#2066gnodet merged 2 commits intoapache:masterfrom
gnodet merged 2 commits intoapache:masterfrom
Conversation
gnodet
reviewed
Jan 28, 2025
| @@ -35,11 +35,12 @@ | |||
| @ThreadSafe | |||
| public interface Mojo { | |||
Contributor
There was a problem hiding this comment.
There's a small incoherence between the javadoc on the class which talks about MojoException, which is not the only exception thrown anymore.
Going through AI, It came up with:
/**
* Represents the contract for Mojos to interact with the Maven infrastructure.
* Implementations of this interface define specific build-process behaviors
* that are triggered during a Maven build lifecycle.
*
* The primary entry point is the {@link #execute()} method, which encapsulates
* the behavior of the Mojo and serves as the integration point with Maven.
* This method may throw an {@link Exception} to signal any issues that prevent
* successful execution of the Mojo.
*
* <p>Annotations:</p>
* <ul>
* <li>{@link Experimental}: Indicates that this interface or its implementation
* may still be evolving and could change in future versions.</li>
* <li>{@link FunctionalInterface}: Denotes that this is a functional interface,
* allowing implementations as lambda expressions or method references.</li>
* <li>{@link Consumer}: Signifies that this type is intended to be implemented
* or extended by Maven plugins or extensions and consumed by Maven itself.</li>
* <li>{@link ThreadSafe}: Implies that implementations of this interface must
* be safe to invoke from multiple threads concurrently.</li>
* </ul>
*
* @since 4.0.0
*/
@Experimental
@FunctionalInterface
@Consumer
@ThreadSafe
public interface Mojo {
/**
* Executes the behavior defined by this {@code Mojo}. This method is invoked
* during the Maven build lifecycle to perform the Mojo's designated task.
*
* <p>Implementations should handle any task-specific logic and may communicate
* errors by throwing an {@link Exception}. Error conditions should provide
* sufficient detail to aid troubleshooting.</p>
*
* @throws Exception if any issue occurs that prevents the successful execution
* of the Mojo
*/
void execute() throws Exception;
}
which looks better to me. Wdyt ?
pzygielo
reviewed
Jan 28, 2025
gnodet
reviewed
Jan 28, 2025
Contributor
There was a problem hiding this comment.
I don't think this sentence is correct English. Either grab the one I pasted below, or rephrase it if a problem occurs that prevents the mojo from executing ... ?
gnodet
approved these changes
Jan 29, 2025
Contributor
Author
|
@gnodet thanks! |
|
Resolve #9906 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
JIRA issue: MNG-8541
Following this checklist to help us incorporate your
contribution quickly and easily:
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
[MNG-XXX] SUMMARY,where you replace
MNG-XXXandSUMMARYwith the appropriate JIRA issue.[MNG-XXX] SUMMARY.Best practice is to use the JIRA issue title in both the pull request title and in the first line of the commit message.
mvn clean verifyto make sure basic checks pass. A more thorough check willbe performed on your pull request automatically.
If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.
I hereby declare this contribution to be licensed under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.