Class Problem

java.lang.Object
org.shredzone.acme4j.Problem
All Implemented Interfaces:
Serializable

public class Problem extends Object implements Serializable
A JSON problem. It contains further, machine- and human-readable details about the reason of an error or failure.
See Also:
  • Constructor Details

    • Problem

      public Problem(JSON problem, URL baseUrl)
      Creates a new Problem object.
      Parameters:
      problem - Problem as JSON structure
      baseUrl - Document's base URL to resolve relative URIs against
  • Method Details

    • getType

      public URI getType()
      Returns the problem type. It is always an absolute URI.
    • getTitle

      Returns a short, human-readable summary of the problem. The text may be localized if supported by the server. Empty if the server did not provide a title.
      See Also:
    • getDetail

      Returns a detailed and specific human-readable explanation of the problem. The text may be localized if supported by the server.
      See Also:
    • getInstance

      Returns a URI that identifies the specific occurence of the problem. It is always an absolute URI.
    • getIdentifier

      Returns the Identifier this problem relates to.
      Since:
      2.3
    • getSubProblems

      Returns a list of sub-problems.
    • asJSON

      public JSON asJSON()
      Returns the problem as JSON object, to access other, non-standard fields.
      Returns:
      Problem as JSON object
    • toString

      public String toString()
      Returns a human-readable description of the problem, that is as specific as possible. The description may be localized if supported by the server.

      If getSubProblems() exist, they will be appended.

      Technically, it returns getDetail(). If not set, getTitle() is returned instead. As a last resort, getType() is returned.

      Overrides:
      toString in class Object