Package org.apache.maven.api.services
Interface BuilderProblem
Describes a problem that was encountered during project 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.
- Since:
- 4.0
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
The different severity levels for a problem, in decreasing order. -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the one-based index of the column containing the problem.Gets the exception that caused this problem (if any).int
Gets the one-based index of the line containing the problem.Gets the location of the problem.Gets the message that describes this problem.Gets the severity level of this problem.Gets the hint about the source of the problem.
-
Method Details
-
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 the settings were 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 bygetSource()
.- 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 bygetSource()
.- Returns:
- the one-based index of the column containing the problem or non-positive value if unknown
-
getLocation
Gets the location of the problem. The location is a user-friendly combination of the values fromgetSource()
,getLineNumber()
andgetColumnNumber()
. The exact syntax of the returned value is undefined.- Returns:
- the location of the problem, never
null
-
getException
Gets the exception that caused this problem (if any).- Returns:
- the exception that caused this problem or
null
if not applicable
-
getMessage
Gets the message that describes this problem.- Returns:
- the message describing this problem, never
null
-
getSeverity
Gets the severity level of this problem.- Returns:
- the severity level of this problem, never
null
-