Package io.micronaut.starter.feature.problemjson

Class ProblemJson

java.lang.Object

io.micronaut.starter.feature.problemjson.ProblemJson

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OpenRewriteFeature

@Requires(property="micronaut.starter.feature.problem.json.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class ProblemJson
extends Object
implements OpenRewriteFeature

Feature that enables REST API error responses in the application/problem+json format following the Problem Details specification.

Field Summary

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
ProblemJson()

Method Summary

Modifier and Type	Method	Description
String	getCategory()
String	getDescription()
@NonNull String	getName()	The name of the feature.
List<String>	getRecipes(GeneratorContext generatorContext)
String	getTitle()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getOrder, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Methods inherited from interface io.micronaut.projectgen.core.openrewrite.OpenRewriteFeature

apply, getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Constructor Details

ProblemJson

public ProblemJson()

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

the name of the feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

public String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

getRecipes

public List<String> getRecipes(GeneratorContext generatorContext)

Specified by:

getRecipes in interface OpenRewriteFeature

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.