Package org.apache.maven.api.services

Class ModelBuilderException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.maven.api.services.MavenException

org.apache.maven.api.services.ModelBuilderException

All Implemented Interfaces:

Serializable

@Experimental
public class ModelBuilderException
extends MavenException

The Exception class throw by the ProjectBuilder service.

Since:

4.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ModelBuilderException(ModelBuilderResult result)	Creates a new exception from the specified interim result and its associated problems.

Method Summary

Modifier and Type	Method	Description
String	getModelId()	Gets the identifier of the POM whose effective model could not be built.
List<ModelProblem>	getProblems()	Gets the problems that caused this exception.
ModelBuilderResult	getResult()	Gets the interim result of the model building up to the point where it failed.

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

Constructor Details

ModelBuilderException

public ModelBuilderException(ModelBuilderResult result)

Creates a new exception from the specified interim result and its associated problems.

Parameters:

result - The interim result, may be null.

Method Details

getResult

public ModelBuilderResult getResult()

Gets the interim result of the model building up to the point where it failed.

Returns:

The interim model building result or null if not available.

getModelId

public String getModelId()

Gets the identifier of the POM whose effective model could not be built. The general format of the identifier is <groupId>:<artifactId>:<version> but some of these coordinates may still be unknown at the point the exception is thrown so this information is merely meant to assist the user.

Returns:

The identifier of the POM or an empty string if not known, never null.

getProblems

public List<ModelProblem> getProblems()

Gets the problems that caused this exception.

Returns:

The problems that caused this exception, never null.