Package io.micronaut.http.hateoas

Class VndError

java.lang.Object

io.micronaut.http.hateoas.AbstractResource<JsonError>

io.micronaut.http.hateoas.JsonError

io.micronaut.http.hateoas.VndError

All Implemented Interfaces:

Resource

@Produces("application/vnd.error+json")
public class VndError
extends JsonError

A type that can be used to represent JSON errors that returns a content type of Vnd.Error.

Since:

1.1

Author:

graemerocher

Field Summary

Fields inherited from class io.micronaut.http.hateoas.JsonError

TYPE

Fields inherited from interface io.micronaut.http.hateoas.Resource

EMBEDDED, LINKS

Constructor Summary

Constructors

Constructor	Description
VndError(String message)

Method Summary

Modifier and Type	Method	Description
VndError	embedded(CharSequence ref, Resource resource)	Add an embedded resource with the given reference.
VndError	embedded(CharSequence ref, Resource... resource)	Add an embedded resource with the given reference.
VndError	embedded(CharSequence ref, List<Resource> resourceList)	Add an embedded resource with the given reference.
VndError	link(@Nullable CharSequence ref, @Nullable Link link)	Add a link with the given reference.
VndError	link(@Nullable CharSequence ref, @Nullable String link)	Add a link with the given reference.
VndError	logref(@Nullable String logref)	Sets the logref.
VndError	path(@Nullable String path)	Sets the path.

Methods inherited from class io.micronaut.http.hateoas.JsonError

getLogref, getMessage, getPath, setMessage, toString

Methods inherited from class io.micronaut.http.hateoas.AbstractResource

getEmbedded, getLinks, setEmbedded, setLinks

Methods inherited from class java.lang.Object

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

Constructor Details

VndError

public VndError(String message)

Parameters:

message - The message

Method Details

path

public VndError path(@Nullable
 @Nullable String path)

Description copied from class: JsonError

Sets the path.

Overrides:

path in class JsonError

Parameters:

path - The path

Returns:

This error object

logref

public VndError logref(@Nullable
 @Nullable String logref)

Description copied from class: JsonError

Sets the logref.

Overrides:

logref in class JsonError

Parameters:

logref - The logref

Returns:

This error object

link

public VndError link(@Nullable
 @Nullable CharSequence ref,
 @Nullable
 @Nullable Link link)

Description copied from class: AbstractResource

Add a link with the given reference.

Overrides:

link in class AbstractResource<JsonError>

Parameters:

ref - The reference

link - The link

Returns:

This JsonError

link

public VndError link(@Nullable
 @Nullable CharSequence ref,
 @Nullable
 @Nullable String link)

Description copied from class: AbstractResource

Add a link with the given reference.

Overrides:

link in class AbstractResource<JsonError>

Parameters:

ref - The reference

link - The link

Returns:

This JsonError

embedded

public VndError embedded(CharSequence ref,
 Resource resource)

Description copied from class: AbstractResource

Add an embedded resource with the given reference.

Overrides:

embedded in class AbstractResource<JsonError>

Parameters:

ref - The reference

resource - The resource

Returns:

This JsonError

embedded

public VndError embedded(CharSequence ref,
 Resource... resource)

Description copied from class: AbstractResource

Add an embedded resource with the given reference.

Overrides:

embedded in class AbstractResource<JsonError>

Parameters:

ref - The reference

resource - The resource

Returns:

This JsonError

embedded

public VndError embedded(CharSequence ref,
 List<Resource> resourceList)

Description copied from class: AbstractResource

Add an embedded resource with the given reference.

Overrides:

embedded in class AbstractResource<JsonError>

Parameters:

ref - The reference

resourceList - The resources

Returns:

This JsonError