Helper object that provides limited support for Jackson core annotations.

Set of annotations supported includes:

{link com.fasterxml.jackson.annotation.JsonAlias}: supported on accessors (fields, getters, setters)
{link com.fasterxml.jackson.annotation.JsonIgnore}: supported on accessors (fields, getters, setters)
com.fasterxml.jackson.annotation.JsonIgnoreProperties: supported on classes, but not on accessors
com.fasterxml.jackson.annotation.JsonProperty supported on accessors (fields, getters, setters) to specify explicit inclusion, name override. Other properties (index, required) not supported.
com.fasterxml.jackson.annotation.JsonPropertyOrder: supported on classes, but not on accessors
com.fasterxml.jackson.annotation.JsonAutoDetect: supported on classes

Usage is done by registering this extension with JSON, usually like:

   JSON json = JSON.std.register(JacksonAnnotationExtension.builder()
       // possible configuration calls
       .build());

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	JacksonAnnotationExtension.Builder Builder class for configuring resulting `JacksonAnnotationExtension`.

Field Summary

Modifier and Type	Field and Description
protected final AnnotationBasedValueRWModifier	_modifier
public static final JsonAutoDetect.Value	DEFAULT_VISIBILITY Default visibility settings for Jackson-jr: in addition to being defaults commonly used as the base for creating alternative settings.
public static final JacksonAnnotationExtension	std Extension instance configured with default settings.

Access	Constructor and Description
protected	JacksonAnnotationExtension()
protected	JacksonAnnotationExtension(JacksonAnnotationExtension.Builder b)

Method Summary

Modifier and Type	Method and Description
public static JacksonAnnotationExtension.Builder	builder()
protected void	register(ExtensionContext Context that allows extension to register handlers ctxt) Implements abstract com.fasterxml.jackson.jr.ob.JacksonJrExtension.register. Method called by `JSON` to let extension register handlers it wants to.

Field Detail

_modifier	back to summary
protected final AnnotationBasedValueRWModifier _modifier

DEFAULT_VISIBILITY back to summary

DEFAULT_VISIBILITY	back to summary
public static final JsonAutoDetect.Value DEFAULT_VISIBILITY Default visibility settings for Jackson-jr: in addition to being defaults commonly used as the base for creating alternative settings. For example, to allow auto-detection of ALL fields regardless visibility, but none of setters (without annotation) you could use JacksonAnnotationExtension ext = JacksonAnnotationExtension.builder() .withVisibility(JacksonAnnotationExtension.DEFAULT_VISIBILITY .withFieldVisibility(Visibility.ANY) .withSetterVisibility(Visibility.NONE) ).build(); Default visibility settings are `Visibility.PUBLIC_ONLY` for all other accessors except for setters, for which `Visibility.ANY` is used. In addition, following core settings are also considered: Fields: must also have `com.fasterxml.jackson.jr.ob.JSON.Feature#USE_FIELDS` enabled otherwise `Visibility.NONE` is used Is-getters: must also have `com.fasterxml.jackson.jr.ob.JSON.Feature#USE_IS_GETTERS` enabled otherwise `Visibility.NONE` is used Creators: never auto-detected so setting irrelevant

public static final JsonAutoDetect.Value DEFAULT_VISIBILITY

Default visibility settings for Jackson-jr: in addition to being defaults commonly used as the base for creating alternative settings. For example, to allow auto-detection of ALL fields regardless visibility, but none of setters (without annotation) you could use

  JacksonAnnotationExtension ext = JacksonAnnotationExtension.builder()
     .withVisibility(JacksonAnnotationExtension.DEFAULT_VISIBILITY
         .withFieldVisibility(Visibility.ANY)
         .withSetterVisibility(Visibility.NONE)
      ).build();

Default visibility settings are Visibility.PUBLIC_ONLY for all other accessors except for setters, for which Visibility.ANY is used. In addition, following core settings are also considered:

Fields: must also have com.fasterxml.jackson.jr.ob.JSON.Feature#USE_FIELDS enabled otherwise Visibility.NONE is used
Is-getters: must also have com.fasterxml.jackson.jr.ob.JSON.Feature#USE_IS_GETTERS enabled otherwise Visibility.NONE is used
Creators: never auto-detected so setting irrelevant

std	back to summary
public static final JacksonAnnotationExtension std Extension instance configured with default settings.

JacksonAnnotationExtension	back to summary
protected JacksonAnnotationExtension()

JacksonAnnotationExtension	back to summary
protected JacksonAnnotationExtension(JacksonAnnotationExtension.Builder b)

Method Detail

builder	back to summary
public static JacksonAnnotationExtension.Builder builder()

register	back to summary
protected void register(ExtensionContext ctxt) Implements abstract com.fasterxml.jackson.jr.ob.JacksonJrExtension.register. Doc from com.fasterxml.jackson.jr.ob.JacksonJrExtension.register. Method called by `JSON` to let extension register handlers it wants to. Parameters ctxt:ExtensionContext Context that allows extension to register handlers Annotations @Override

protected void register(ExtensionContext ctxt)

Implements abstract com.fasterxml.jackson.jr.ob.JacksonJrExtension.register.

Doc from com.fasterxml.jackson.jr.ob.JacksonJrExtension.register.

Method called by JSON to let extension register handlers it wants to.

Parameters

ctxt:ExtensionContext: Context that allows extension to register handlers

Annotations

@Override

com.fasterxml.jackson.jr.annotationsupport back to summary

public Class JacksonAnnotationExtension.Builder

Class Inheritance

extends Object

java.lang.Object
com.fasterxml.jackson.jr.annotationsupport.JacksonAnnotationExtension.Builder

Builder class for configuring resulting JacksonAnnotationExtension.

Field Summary

Modifier and Type	Field and Description
public JsonAutoDetect.Value	visibility

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public JacksonAnnotationExtension	build()
public JacksonAnnotationExtension.Builder	Returns: Builder with specified visibility settings withVisibility(JsonAutoDetect.Value Visibility settings to use, or `null` to indicate "use default visibility" (see `JacksonAnnotationExtension#DEFAULT_VISIBILITY`). allVisibility) Method for setting visibility settings to specified parameter and returning resulting builder instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

visibility	back to summary
public JsonAutoDetect.Value visibility

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public JacksonAnnotationExtension build()

withVisibility back to summary

withVisibility	back to summary
public JacksonAnnotationExtension.Builder withVisibility(JsonAutoDetect.Value allVisibility) Method for setting visibility settings to specified parameter and returning resulting builder instance. Parameters allVisibility:JsonAutoDetect.Value Visibility settings to use, or `null` to indicate "use default visibility" (see `JacksonAnnotationExtension#DEFAULT_VISIBILITY`). Returns:JacksonAnnotationExtension.Builder Builder with specified visibility settings

public JacksonAnnotationExtension.Builder withVisibility(JsonAutoDetect.Value allVisibility)

Method for setting visibility settings to specified parameter and returning resulting builder instance.

Parameters

allVisibility:JsonAutoDetect.Value: Visibility settings to use, or null to indicate "use default visibility" (see JacksonAnnotationExtension#DEFAULT_VISIBILITY).

Returns:JacksonAnnotationExtension.Builder

Builder with specified visibility settings