org.apache.maven.model.building
Interface ModelProblem

All Known Implementing Classes:

DefaultModelProblem

public interface ModelProblem

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.

Author:

Benjamin Bentmann

Nested Class Summary

static class

ModelProblem.Severity The different severity levels for a problem, in decreasing order.

Method Summary

int	getColumnNumber() Gets the one-based index of the column containing the problem.
java.lang.Exception	getException() Gets the exception that caused this problem (if any).
int	getLineNumber() Gets the one-based index of the line containing the problem.
java.lang.String	getLocation() Gets the location of the problem.
java.lang.String	getMessage() Gets the message that describes this problem.
java.lang.String	getModelId() Gets the identifier of the model from which the problem originated.
ModelProblem.Severity	getSeverity() Gets the severity level of this problem.
java.lang.String	getSource() Gets the hint about the source of the problem.

Method Detail

getSource

java.lang.String getSource()

Gets the hint about the source of the problem. While the syntax of this hint is unspecified and depends on the creator of the problem, the general expectation is that the hint provides sufficient information to the user to track the problem back to its origin. A concrete example for such a source hint can be the file path or URL from which a POM was read.

Returns:

The hint about the source of the problem or an empty string if unknown, never null.

getLineNumber

int getLineNumber()

Gets the one-based index of the line containing the problem. The line number should refer to some text file that is given by getSource().

Returns:

The one-based index of the line containing the problem or a non-positive value if unknown.

getColumnNumber

int getColumnNumber()

Gets the one-based index of the column containing the problem. The column number should refer to some text file that is given by getSource().

Returns:

The one-based index of the column containing the problem or non-positive value if unknown.

getModelId

java.lang.String getModelId()

Gets the identifier of the model from which the problem originated. While the general form of this identifier is groupId:artifactId:version the returned identifier need not be complete. The identifier is derived from the information that is available at the point the problem occurs and as such merely serves as a 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.

getLocation

java.lang.String getLocation()

Gets the location of the problem. The location is a user-friendly combination of the values from getModelId(), getSource(), getLineNumber() and getColumnNumber(). The exact syntax of the returned value is undefined.

Returns:

The location of the problem, never null.

getException

java.lang.Exception getException()

Gets the exception that caused this problem (if any).

Returns:

The exception that caused this problem or null if not applicable.

getMessage

java.lang.String getMessage()

Gets the message that describes this problem.

Returns:

The message describing this problem, never null.

getSeverity

ModelProblem.Severity getSeverity()

Gets the severity level of this problem.

Returns:

The severity level of this problem, never null.