Package org.apache.maven.internal.impl
Class DefaultBuilderProblem
java.lang.Object
org.apache.maven.internal.impl.DefaultBuilderProblem
- All Implemented Interfaces:
BuilderProblem
Describes a problem that was encountered during settings 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 settings file
that exhibits the problem.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.maven.api.services.BuilderProblem
BuilderProblem.Severity
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final int
(package private) final Exception
(package private) final int
(package private) final String
(package private) final BuilderProblem.Severity
(package private) final String
-
Constructor Summary
ConstructorsConstructorDescriptionDefaultBuilderProblem
(String source, int lineNumber, int columnNumber, Exception exception, String message, BuilderProblem.Severity severity) -
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.toString()
-
Field Details
-
source
-
lineNumber
final int lineNumber -
columnNumber
final int columnNumber -
exception
-
message
-
severity
-
-
Constructor Details
-
DefaultBuilderProblem
DefaultBuilderProblem(String source, int lineNumber, int columnNumber, Exception exception, String message, BuilderProblem.Severity severity)
-
-
Method Details
-
getSource
Description copied from interface:BuilderProblem
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.- Specified by:
getSource
in interfaceBuilderProblem
- 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:BuilderProblem
Gets the one-based index of the line containing the problem. The line number should refer to some text file that is given byBuilderProblem.getSource()
.- Specified by:
getLineNumber
in interfaceBuilderProblem
- 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:BuilderProblem
Gets the one-based index of the column containing the problem. The column number should refer to some text file that is given byBuilderProblem.getSource()
.- Specified by:
getColumnNumber
in interfaceBuilderProblem
- Returns:
- the one-based index of the column containing the problem or non-positive value if unknown
-
getException
Description copied from interface:BuilderProblem
Gets the exception that caused this problem (if any).- Specified by:
getException
in interfaceBuilderProblem
- Returns:
- the exception that caused this problem or
null
if not applicable
-
getMessage
Description copied from interface:BuilderProblem
Gets the message that describes this problem.- Specified by:
getMessage
in interfaceBuilderProblem
- Returns:
- the message describing this problem, never
null
-
getSeverity
Description copied from interface:BuilderProblem
Gets the severity level of this problem.- Specified by:
getSeverity
in interfaceBuilderProblem
- Returns:
- the severity level of this problem, never
null
-
getLocation
Description copied from interface:BuilderProblem
Gets the location of the problem. The location is a user-friendly combination of the values fromBuilderProblem.getSource()
,BuilderProblem.getLineNumber()
andBuilderProblem.getColumnNumber()
. The exact syntax of the returned value is undefined.- Specified by:
getLocation
in interfaceBuilderProblem
- Returns:
- the location of the problem, never
null
-
toString
-