Package org.apache.maven.internal.impl

Class DefaultBuilderProblem

java.lang.Object

org.apache.maven.internal.impl.DefaultBuilderProblem

All Implemented Interfaces:

BuilderProblem

class DefaultBuilderProblem
extends Object
implements 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

Fields

Modifier and Type	Field	Description
(package private) final int	columnNumber
(package private) final Exception	exception
(package private) final int	lineNumber
(package private) final String	message
(package private) final BuilderProblem.Severity	severity
(package private) final String	source

Constructor Summary

Constructors

Constructor	Description
DefaultBuilderProblem(String source, int lineNumber, int columnNumber, Exception exception, String message, BuilderProblem.Severity severity)

Method Summary

Modifier and Type	Method	Description
int	getColumnNumber()	Gets the one-based index of the column containing the problem.
Exception	getException()	Gets the exception that caused this problem (if any).
int	getLineNumber()	Gets the one-based index of the line containing the problem.
String	getLocation()	Gets the location of the problem.
String	getMessage()	Gets the message that describes this problem.
BuilderProblem.Severity	getSeverity()	Gets the severity level of this problem.
String	getSource()	Gets the hint about the source of the problem.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

source

final String source

lineNumber

final int lineNumber

columnNumber

final int columnNumber

exception

final Exception exception

message

final String message

severity

final BuilderProblem.Severity severity

Constructor Details

DefaultBuilderProblem

DefaultBuilderProblem(String source,
 int lineNumber,
 int columnNumber,
 Exception exception,
 String message,
 BuilderProblem.Severity severity)

Method Details

getSource

public String 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 interface BuilderProblem

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 by BuilderProblem.getSource().

Specified by:

getLineNumber in interface BuilderProblem

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 by BuilderProblem.getSource().

Specified by:

getColumnNumber in interface BuilderProblem

Returns:

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

getException

public Exception getException()

Description copied from interface: BuilderProblem

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

Specified by:

getException in interface BuilderProblem

Returns:

the exception that caused this problem or null if not applicable

getMessage

public String getMessage()

Description copied from interface: BuilderProblem

Gets the message that describes this problem.

Specified by:

getMessage in interface BuilderProblem

Returns:

the message describing this problem, never null

getSeverity

public BuilderProblem.Severity getSeverity()

Description copied from interface: BuilderProblem

Gets the severity level of this problem.

Specified by:

getSeverity in interface BuilderProblem

Returns:

the severity level of this problem, never null

getLocation

public String getLocation()

Description copied from interface: BuilderProblem

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

Specified by:

getLocation in interface BuilderProblem

Returns:

the location of the problem, never null

toString

public String toString()

Overrides:

toString in class Object