Package org.apache.maven.api.services

Interface ModelProblem

All Superinterfaces:

BuilderProblem

All Known Implementing Classes:

DefaultModelProblem

public interface ModelProblem
extends BuilderProblem

Describes a problem that was encountered during model building. A problem can either be an exception that was thrown or a simple string message. In addition, a problem carries a hint about its source, e.g. the POM file that exhibits the problem.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ModelProblem.Version	Version

Nested classes/interfaces inherited from interface org.apache.maven.api.services.BuilderProblem

BuilderProblem.Severity

Method Summary

Modifier and Type	Method	Description
String	getModelId()	Gets the identifier of the model from which the problem originated.
ModelProblem.Version	getVersion()	Gets the applicable maven version/validation level of this problem

Methods inherited from interface org.apache.maven.api.services.BuilderProblem

getColumnNumber, getException, getLineNumber, getLocation, getMessage, getSeverity, getSource

Method Details

getModelId

@Nonnull
String getModelId()

Gets the identifier of the model from which the problem originated. The identifier is derived from the information that is available at the point the problem occurs and as such merely serves as best effort to provide information to the user to track the problem back to its origin.

Returns:

The identifier of the model from which the problem originated or an empty string if unknown, never null.

getVersion

@Nonnull
ModelProblem.Version getVersion()

Gets the applicable maven version/validation level of this problem

Returns:

The version, never null.