Class MojoException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.maven.api.services.MavenException

org.apache.maven.api.plugin.MojoException

All Implemented Interfaces:

Serializable

@Experimental
public class MojoException
extends MavenException

An exception occurring during the execution of a plugin.

Since:

4.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	longMessage
protected Object	source

Constructor Summary

Constructors

Constructor	Description
MojoException(Object source, String shortMessage, String longMessage)	Constructs a new MojoException providing the source and a short and long message.
MojoException(String message)	Constructs a new MojoException providing a message.
MojoException(String message, Throwable cause)	Constructs a new MojoException wrapping an underlying Throwable and providing a message.
MojoException(Throwable cause)	Constructs a new MojoExecutionException wrapping an underlying Throwable.

Method Summary

Modifier and Type	Method	Description
String	getLongMessage()
Object	getSource()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

source

protected Object source

longMessage

protected String longMessage

Constructor Details

MojoException

public MojoException(Object source,
 String shortMessage,
 String longMessage)

Constructs a new MojoException providing the source and a short and long message. These messages are used to improve the message written at the end of Maven build.

MojoException

public MojoException(String message,
 Throwable cause)

Constructs a new MojoException wrapping an underlying Throwable and providing a message.

MojoException

public MojoException(String message)

Constructs a new MojoException providing a message.

MojoException

public MojoException(Throwable cause)

Constructs a new MojoExecutionException wrapping an underlying Throwable.

Parameters:

cause - the cause which is saved for later retrieval by the Throwable.getCause() method. A null value is permitted, and indicates that the cause is nonexistent or unknown.

Method Details

getLongMessage

public String getLongMessage()

getSource

public Object getSource()