Package org.apache.juneau.bean.jsonapi

Class JsonApiErrorSource

java.lang.Object

org.apache.juneau.bean.jsonapi.JsonApiErrorSource

@Marshalled
public class JsonApiErrorSource
extends Object

Represents the source sub-object of a JSON:API Error Object.

Per JSON:API v1.1 § Error Objects, the source object can carry a pointer (JSON Pointer to the offending element), a parameter (the URI query parameter name), and/or a header (the request header name).

Constructor Summary

Constructors

Constructor	Description
JsonApiErrorSource()	Default constructor.

Method Summary

Modifier and Type	Method	Description
String	getHeader()	Bean property getter: header.
String	getParameter()	Bean property getter: parameter.
String	getPointer()	Bean property getter: pointer.
JsonApiErrorSource	setHeader(String value)	Bean property setter: header.
JsonApiErrorSource	setParameter(String value)	Bean property setter: parameter.
JsonApiErrorSource	setPointer(String value)	Bean property setter: pointer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JsonApiErrorSource

public JsonApiErrorSource()

Default constructor.

Method Details

getPointer

public String getPointer()

Bean property getter: pointer.

Returns:

The value of the pointer property, or null if it is not set.

setPointer

public JsonApiErrorSource setPointer(String value)

Bean property setter: pointer.

Parameters:

value - The new value for this property. Can be null to unset the property.

Returns:

This object.

getParameter

public String getParameter()

Bean property getter: parameter.

Returns:

The value of the parameter property, or null if it is not set.

setParameter

public JsonApiErrorSource setParameter(String value)

Bean property setter: parameter.

Parameters:

value - The new value for this property. Can be null to unset the property.

Returns:

This object.

getHeader

public String getHeader()

Bean property getter: header.

Returns:

The value of the header property, or null if it is not set.

setHeader

public JsonApiErrorSource setHeader(String value)

Bean property setter: header.

Parameters:

value - The new value for this property. Can be null to unset the property.

Returns:

This object.

toString

public String toString()

Overrides:

toString in class Object