Class DefaultModelProblem

java.lang.Object
org.apache.maven.impl.model.DefaultModelProblem
All Implemented Interfaces:
org.apache.maven.api.services.BuilderProblem, org.apache.maven.api.services.ModelProblem

public class DefaultModelProblem extends Object implements org.apache.maven.api.services.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.api.services.BuilderProblem

    org.apache.maven.api.services.BuilderProblem.Severity

    Nested classes/interfaces inherited from interface org.apache.maven.api.services.ModelProblem

    org.apache.maven.api.services.ModelProblem.Version
  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultModelProblem(String message, org.apache.maven.api.services.BuilderProblem.Severity severity, org.apache.maven.api.services.ModelProblem.Version version, String source, int lineNumber, int columnNumber, String modelId, Exception exception)
    Creates a new problem with the specified message and exception.
    DefaultModelProblem(String message, org.apache.maven.api.services.BuilderProblem.Severity severity, org.apache.maven.api.services.ModelProblem.Version version, org.apache.maven.api.model.Model source, int lineNumber, int columnNumber, Exception exception)
    Creates a new problem with the specified message and exception.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
     
     
    int
     
     
     
     
    org.apache.maven.api.services.BuilderProblem.Severity
     
     
    org.apache.maven.api.services.ModelProblem.Version
     
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • DefaultModelProblem

      public DefaultModelProblem(String message, org.apache.maven.api.services.BuilderProblem.Severity severity, org.apache.maven.api.services.ModelProblem.Version version, org.apache.maven.api.model.Model source, int lineNumber, int columnNumber, Exception exception)
      Creates a new problem with the specified message and exception.
      Parameters:
      message - The message describing the problem, may be null.
      severity - The severity level of the problem, may be null to default to BuilderProblem.Severity.ERROR.
      source - The source of the problem, may be null.
      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 be null.
    • DefaultModelProblem

      public DefaultModelProblem(String message, org.apache.maven.api.services.BuilderProblem.Severity severity, org.apache.maven.api.services.ModelProblem.Version version, String source, int lineNumber, int columnNumber, String modelId, Exception exception)
      Creates a new problem with the specified message and exception.
      Parameters:
      message - The message describing the problem, may be null.
      severity - The severity level of the problem, may be null to default to BuilderProblem.Severity.ERROR.
      version - The version since the problem is relevant
      source - A hint about the source of the problem like a file path, may be null.
      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 be null.
      exception - The exception that caused this problem, may be null.
  • Method Details

    • getSource

      public String getSource()
      Specified by:
      getSource in interface org.apache.maven.api.services.BuilderProblem
    • getLineNumber

      public int getLineNumber()
      Specified by:
      getLineNumber in interface org.apache.maven.api.services.BuilderProblem
    • getColumnNumber

      public int getColumnNumber()
      Specified by:
      getColumnNumber in interface org.apache.maven.api.services.BuilderProblem
    • getModelId

      public String getModelId()
      Specified by:
      getModelId in interface org.apache.maven.api.services.ModelProblem
    • getException

      public Exception getException()
      Specified by:
      getException in interface org.apache.maven.api.services.BuilderProblem
    • getLocation

      public String getLocation()
      Specified by:
      getLocation in interface org.apache.maven.api.services.BuilderProblem
    • getMessage

      public String getMessage()
      Specified by:
      getMessage in interface org.apache.maven.api.services.BuilderProblem
    • getSeverity

      public org.apache.maven.api.services.BuilderProblem.Severity getSeverity()
      Specified by:
      getSeverity in interface org.apache.maven.api.services.BuilderProblem
    • getVersion

      public org.apache.maven.api.services.ModelProblem.Version getVersion()
      Specified by:
      getVersion in interface org.apache.maven.api.services.ModelProblem
    • toString

      public String toString()
      Overrides:
      toString in class Object