Problem (commons 7.0.8-v.41 API)

All Superinterfaces:

yakworks.i18n.MsgKey, yakworks.i18n.MsgKeyDecorator, Result

All Known Subinterfaces:

Exceptional
```
public interface Problem
extends Result
```
Problem instances are required to be immutable.

See Also:

RFC 7807: Problem Details for HTTP APIs

Field Summary

Fields
Modifier and Type Field and Description

static java.net.URI DEFAULT_TYPE

Fields
Modifier and Type	Field and Description
`static java.net.URI`	`DEFAULT_TYPE`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static yakworks.problem.ProblemBuilder`	`builder()` Optional, additional attributes of the problem.
`static yakworks.problem.ProblemException`	`create()`
`default java.lang.String`	`getDetail()` A human readable explanation specific to this occurrence of the problem.
`default java.net.URI`	`getInstance()` An absolute URI that identifies the specific occurrence of the problem.
`default yakworks.i18n.MsgKey`	`getMsg()`
`default java.lang.Boolean`	`getOk()` success or fail? if ok is true then it still may mean that there are warnings and needs to be looked into
`default java.net.URI`	`getType()` An absolute URI that identifies the problem type.
`default java.util.List<Violation>`	`getViolations()` The list of constraint violations or any others
`static yakworks.problem.ProblemException`	`of(ApiStatus status)`
`static yakworks.problem.ProblemException`	`of(ApiStatus status, java.lang.String detail)`
`static yakworks.problem.ProblemException`	`of(yakworks.i18n.MsgKey msg)`
`static yakworks.problem.ProblemException`	`of(java.lang.String code, java.lang.Object args)`
`default void`	`setDetail(java.lang.String v)`
`default void`	`setType(java.net.URI v)`
`default void`	`setViolations(java.util.List<Violation> v)`

Methods inherited from interface yakworks.api.Result
getDefaultCode, getPayload, getStatus, getTitle, OK, setPayload, setStatus, setTitle

Methods inherited from interface yakworks.i18n.MsgKeyDecorator
getArgs, getCode, setArgs, setCode, setMsg

Methods inherited from interface yakworks.i18n.MsgKey
empty, getFallbackMessage, of, setArgs, setFallbackMessage

- Field Detail
  - DEFAULT_TYPE
```
static final java.net.URI DEFAULT_TYPE
```
- Method Detail
  - getOk
```
default java.lang.Boolean getOk()
```
    Description copied from interface: Result
    
    success or fail? if ok is true then it still may mean that there are warnings and needs to be looked into
    
    Specified by:
    
    getOk in interface Result
  - getMsg
```
default yakworks.i18n.MsgKey getMsg()
```
    Specified by:
    
    getMsg in interface yakworks.i18n.MsgKeyDecorator
  - getType
```
default java.net.URI getType()
```
    An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML). When this member is not present, its value is assumed to be "about:blank".
    
    Returns:
    
    an absolute URI that identifies this problem's type
  - setType
```
default void setType(java.net.URI v)
```
  - getDetail
```
default java.lang.String getDetail()
```
    A human readable explanation specific to this occurrence of the problem.
    
    Returns:
    
    A human readable explaination of this problem
  - setDetail
```
default void setDetail(java.lang.String v)
```
  - getViolations
```
default java.util.List<Violation> getViolations()
```
    The list of constraint violations or any others
  - setViolations
```
default void setViolations(java.util.List<Violation> v)
```
  - getInstance
```
@Nullable
default java.net.URI getInstance()
```
    An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
    
    Returns:
    
    an absolute URI that identifies this specific problem
  - builder
```
static yakworks.problem.ProblemBuilder builder()
```
    Optional, additional attributes of the problem. Implementations can choose to ignore this in favor of concrete, typed fields.
    
    Returns:
    
    additional parameters
  - create
```
static yakworks.problem.ProblemException create()
```
  - of
```
static yakworks.problem.ProblemException of(ApiStatus status)
```
  - of
```
static yakworks.problem.ProblemException of(ApiStatus status,
                                            java.lang.String detail)
```
  - of
```
static yakworks.problem.ProblemException of(yakworks.i18n.MsgKey msg)
```
  - of
```
static yakworks.problem.ProblemException of(java.lang.String code,
                                            java.lang.Object args)
```
    Specified by:
    
    of in interface yakworks.i18n.MsgKey

Interface Problem

Field Summary

Method Summary

Methods inherited from interface yakworks.api.Result

Methods inherited from interface yakworks.i18n.MsgKeyDecorator

Methods inherited from interface yakworks.i18n.MsgKey

Field Detail

DEFAULT_TYPE

Method Detail

getOk

getMsg

getType

setType

getDetail

setDetail

getViolations

setViolations

getInstance

builder

create

of

of

of

of