Package org.apache.maven.model.building
Class DefaultModelProblem
- java.lang.Object
-
- org.apache.maven.model.building.DefaultModelProblem
-
- All Implemented Interfaces:
ModelProblem
public class DefaultModelProblem extends java.lang.Object implements 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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.maven.model.building.ModelProblem
ModelProblem.Severity, ModelProblem.Version
-
-
Field Summary
Fields Modifier and Type Field Description private int
columnNumber
private java.lang.Exception
exception
private int
lineNumber
private java.lang.String
message
private java.lang.String
modelId
private ModelProblem.Severity
severity
private java.lang.String
source
private ModelProblem.Version
version
-
Constructor Summary
Constructors Constructor Description DefaultModelProblem(java.lang.String message, ModelProblem.Severity severity, ModelProblem.Version version, java.lang.String source, int lineNumber, int columnNumber, java.lang.String modelId, java.lang.Exception exception)
Creates a new problem with the specified message and exception.DefaultModelProblem(java.lang.String message, ModelProblem.Severity severity, ModelProblem.Version version, Model source, int lineNumber, int columnNumber, java.lang.Exception exception)
Creates a new problem with the specified message and exception.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
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.ModelProblem.Version
getVersion()
Gets the applicable maven version/validation level of this problemjava.lang.String
toString()
-
-
-
Field Detail
-
source
private final java.lang.String source
-
lineNumber
private final int lineNumber
-
columnNumber
private final int columnNumber
-
modelId
private final java.lang.String modelId
-
message
private final java.lang.String message
-
exception
private final java.lang.Exception exception
-
severity
private final ModelProblem.Severity severity
-
version
private final ModelProblem.Version version
-
-
Constructor Detail
-
DefaultModelProblem
public DefaultModelProblem(java.lang.String message, ModelProblem.Severity severity, ModelProblem.Version version, Model source, int lineNumber, int columnNumber, java.lang.Exception exception)
Creates a new problem with the specified message and exception.- Parameters:
message
- The message describing the problem, may benull
.severity
- The severity level of the problem, may benull
to default toModelProblem.Severity.ERROR
.source
- The source of the problem, may benull
.lineNumber
- The one-based index of the line containing the error or-1
if unknown.columnNumber
- The one-based index of the column containing the error or-1
if unknown.exception
- The exception that caused this problem, may benull
.
-
DefaultModelProblem
public DefaultModelProblem(java.lang.String message, ModelProblem.Severity severity, ModelProblem.Version version, java.lang.String source, int lineNumber, int columnNumber, java.lang.String modelId, java.lang.Exception exception)
Creates a new problem with the specified message and exception.- Parameters:
message
- The message describing the problem, may benull
.severity
- The severity level of the problem, may benull
to default toModelProblem.Severity.ERROR
.version
- The version since the problem is relevantsource
- A hint about the source of the problem like a file path, may benull
.lineNumber
- The one-based index of the line containing the problem or-1
if unknown.columnNumber
- The one-based index of the column containing the problem or-1
if unknown.modelId
- The identifier of the model that exhibits the problem, may benull
.exception
- The exception that caused this problem, may benull
.
-
-
Method Detail
-
getSource
public java.lang.String getSource()
Description copied from interface:ModelProblem
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.- Specified by:
getSource
in interfaceModelProblem
- Returns:
- The hint about the source of the problem or an empty string if unknown, never
null
.
-
getLineNumber
public int getLineNumber()
Description copied from interface:ModelProblem
Gets the one-based index of the line containing the problem. The line number should refer to some text file that is given byModelProblem.getSource()
.- Specified by:
getLineNumber
in interfaceModelProblem
- Returns:
- The one-based index of the line containing the problem or a non-positive value if unknown.
-
getColumnNumber
public int getColumnNumber()
Description copied from interface:ModelProblem
Gets the one-based index of the column containing the problem. The column number should refer to some text file that is given byModelProblem.getSource()
.- Specified by:
getColumnNumber
in interfaceModelProblem
- Returns:
- The one-based index of the column containing the problem or non-positive value if unknown.
-
getModelId
public java.lang.String getModelId()
Description copied from interface:ModelProblem
Gets the identifier of the model from which the problem originated. While the general form of this identifier isgroupId: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.- Specified by:
getModelId
in interfaceModelProblem
- Returns:
- The identifier of the model from which the problem originated or an empty string if unknown, never
null
.
-
getException
public java.lang.Exception getException()
Description copied from interface:ModelProblem
Gets the exception that caused this problem (if any).- Specified by:
getException
in interfaceModelProblem
- Returns:
- The exception that caused this problem or
null
if not applicable.
-
getMessage
public java.lang.String getMessage()
Description copied from interface:ModelProblem
Gets the message that describes this problem.- Specified by:
getMessage
in interfaceModelProblem
- Returns:
- The message describing this problem, never
null
.
-
getSeverity
public ModelProblem.Severity getSeverity()
Description copied from interface:ModelProblem
Gets the severity level of this problem.- Specified by:
getSeverity
in interfaceModelProblem
- Returns:
- The severity level of this problem, never
null
.
-
getVersion
public ModelProblem.Version getVersion()
Description copied from interface:ModelProblem
Gets the applicable maven version/validation level of this problem- Specified by:
getVersion
in interfaceModelProblem
- Returns:
- The version, never
null
.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-