org.springframework.hateoas.mediatype.problem

Class Problem

java.lang.Object

org.springframework.hateoas.mediatype.problem.Problem

Direct Known Subclasses:

Problem.ExtendedProblem

public class Problem
extends Object

Encapsulation of an RFC-7807 Problem code. While it complies out-of-the-box, it may also be extended to support domain-specific details.

Author:

Greg Turnquist, Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Problem.ExtendedProblem<T>

Constructor Summary

Constructors

Constructor and Description
Problem(URI type, String title, int status, String detail, URI instance)

Method Summary

Modifier and Type	Method and Description
static Problem	create() Returns an empty Problem instance.
static <T> Problem.ExtendedProblem<T>	create(T payload) Returns an Problem.ExtendedProblem with the given payload as additional properties.
static Problem	statusOnly(HttpStatus status) Returns a Problem instance with the given HttpStatus and defaults as defined in RFC7807.
Problem.ExtendedProblem<Map<String,Object>>	withProperties(Consumer<Map<String,Object>> consumer) Returns an Problem.ExtendedProblem with a Map populated by the given consumer as payload.
Problem.ExtendedProblem<Map<String,Object>>	withProperties(Map<String,Object> properties) Returns an Problem.ExtendedProblem with the given Map unwrapping as additional properties.
<T> Problem.ExtendedProblem<T>	withProperties(T payload) Creates a new Problem.ExtendedProblem with the given payload as additional properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

Problem

public Problem(URI type,
               String title,
               int status,
               String detail,
               URI instance)

Method Detail

create

public static Problem create()

Returns an empty Problem instance.

Returns:

an empty Problem instance.

create

public static <T> Problem.ExtendedProblem<T> create(T payload)

Returns an Problem.ExtendedProblem with the given payload as additional properties.

Type Parameters:

T -

Parameters:

payload - must not be null.

Returns:

statusOnly

public static Problem statusOnly(HttpStatus status)

Returns a Problem instance with the given HttpStatus and defaults as defined in RFC7807.

Parameters:

status - must not be null.

Returns:

See Also:

RFC7807

withProperties

public <T> Problem.ExtendedProblem<T> withProperties(T payload)

Creates a new Problem.ExtendedProblem with the given payload as additional properties.

Type Parameters:

T -

Parameters:

payload - must not be null.

Returns:

withProperties

public Problem.ExtendedProblem<Map<String,Object>> withProperties(Consumer<Map<String,Object>> consumer)

Returns an Problem.ExtendedProblem with a Map populated by the given consumer as payload.

Parameters:

consumer - must not be null.

Returns:

withProperties

public Problem.ExtendedProblem<Map<String,Object>> withProperties(Map<String,Object> properties)

Returns an Problem.ExtendedProblem with the given Map unwrapping as additional properties.

Parameters:

properties - must not be null.

Returns: