ErrorDataBuilder (katharsis-core 0.9.3 API)

java.lang.Object
- io.katharsis.errorhandling.ErrorDataBuilder

public class ErrorDataBuilder
extends Object

Constructor Summary

Constructors
Constructor and Description

ErrorDataBuilder()

Constructors
Constructor and Description
`ErrorDataBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ErrorDataBuilder`	`addMetaField(String key, Object value)`
`ErrorData`	`build()`
`ErrorDataBuilder`	`setAboutLink(String aboutLink)` A link that leads to further details about this particular occurrence of the problem.
`ErrorDataBuilder`	`setCode(String code)` An application-specific error code, expressed as a string value.
`ErrorDataBuilder`	`setDetail(String detail)` A human-readable explanation specific to this occurrence of the problem.
`ErrorDataBuilder`	`setId(String id)`
`ErrorDataBuilder`	`setMeta(Map<String,Object> meta)` A meta object containing non-standard meta-information about the error.
`ErrorDataBuilder`	`setSourceParameter(String sourceParameter)` A string indicating which query parameter caused the error.
`ErrorDataBuilder`	`setSourcePointer(String sourcePointer)` A JSON Pointer [RFC6901] to the associated entity in the request document [e.g.
`ErrorDataBuilder`	`setStatus(String status)` The HTTP status code applicable to this problem, expressed as a string value.
`ErrorDataBuilder`	`setTitle(String title)` A short, human-readable summary of the problem.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ErrorDataBuilder
```
public ErrorDataBuilder()
```
- Method Detail
  - setId
```
public ErrorDataBuilder setId(String id)
```
    Parameters:
    
    id - A unique identifier for this particular occurrence of the problem.
    
    Returns:
    
    ErrorDataBuilder
  - setAboutLink
```
public ErrorDataBuilder setAboutLink(String aboutLink)
```
    A link that leads to further details about this particular occurrence of the problem. Wrapped in "links" object.
  - setStatus
```
public ErrorDataBuilder setStatus(String status)
```
    The HTTP status code applicable to this problem, expressed as a string value.
  - setCode
```
public ErrorDataBuilder setCode(String code)
```
    An application-specific error code, expressed as a string value.
  - setTitle
```
public ErrorDataBuilder setTitle(String title)
```
    A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
  - setDetail
```
public ErrorDataBuilder setDetail(String detail)
```
    A human-readable explanation specific to this occurrence of the problem.
  - setSourcePointer
```
public ErrorDataBuilder setSourcePointer(String sourcePointer)
```
    A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute]. Wrapped in "source" object.
  - setSourceParameter
```
public ErrorDataBuilder setSourceParameter(String sourceParameter)
```
    A string indicating which query parameter caused the error. Wrapped in "source" object.
  - setMeta
```
public ErrorDataBuilder setMeta(Map<String,Object> meta)
```
    A meta object containing non-standard meta-information about the error.
  - addMetaField
```
public ErrorDataBuilder addMetaField(String key,
                                     Object value)
```
  - build
```
public ErrorData build()
```

Class ErrorDataBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ErrorDataBuilder

Method Detail

setId

setAboutLink

setStatus

setCode

setTitle

setDetail

setSourcePointer

setSourceParameter

setMeta

addMetaField

build