Modul org.shredzone.acme4j

Package org.shredzone.acme4j

Klasse Problem

java.lang.Object

org.shredzone.acme4j.Problem

Alle implementierten Schnittstellen:

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.

Siehe auch:

• RFC 7807
• Serialisierte Form

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Problem(JSON problem, URL baseUrl)	Creates a new Problem object.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
JSON	asJSON()	Returns the problem as JSON object, to access other, non-standard fields.
Optional<String>	getDetail()	Returns a detailed and specific human-readable explanation of the problem.
Optional<Identifier>	getIdentifier()	Returns the Identifier this problem relates to.
Optional<URI>	getInstance()	Returns a URI that identifies the specific occurence of the problem.
List<Problem>	getSubProblems()	Returns a list of sub-problems.
Optional<String>	getTitle()	Returns a short, human-readable summary of the problem.
URI	getType()	Returns the problem type.
String	toString()	Returns a human-readable description of the problem, that is as specific as possible.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

Problem

public Problem(JSON problem,
 URL baseUrl)

Creates a new Problem object.

Parameter:

problem - Problem as JSON structure

baseUrl - Document's base URL to resolve relative URIs against

Methodendetails

getType

public URI getType()

Returns the problem type. It is always an absolute URI.

getTitle

public Optional<String> 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.

Siehe auch:

• toString()

getDetail

public Optional<String> getDetail()

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

Siehe auch:

• toString()

getInstance

public Optional<URI> getInstance()

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

getIdentifier

public Optional<Identifier> getIdentifier()

Returns the Identifier this problem relates to.

Seit:

2.3

getSubProblems

public List<Problem> getSubProblems()

Returns a list of sub-problems.

asJSON

public JSON asJSON()

Returns the problem as JSON object, to access other, non-standard fields.

Gibt zurück:

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.

Setzt außer Kraft:

toString in Klasse Object