com.fasterxml.jackson.jr.annotationsupport

Class JacksonAnnotationExtension

java.lang.Object

com.fasterxml.jackson.jr.ob.JacksonJrExtension

com.fasterxml.jackson.jr.annotationsupport.JacksonAnnotationExtension

public class JacksonAnnotationExtension
extends com.fasterxml.jackson.jr.ob.JacksonJrExtension

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)
• JsonIgnoreProperties: supported on classes, but not on accessors
• JsonProperty supported on accessors (fields, getters, setters) to specify explicit inclusion, name override. Other properties (index, required) not supported.
• JsonPropertyOrder: supported on classes, but not on accessors
• 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());

Since:

2.11

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static JacksonAnnotationExtension.Builder	builder()
protected void	register(com.fasterxml.jackson.jr.ob.api.ExtensionContext ctxt)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VISIBILITY

public static final com.fasterxml.jackson.annotation.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 JSON.Feature.USE_FIELDS enabled otherwise Visibility.NONE is used
• Is-getters: must also have JSON.Feature.USE_IS_GETTERS enabled otherwise Visibility.NONE is used
• Creators: never auto-detected so setting irrelevant

_modifier

protected final AnnotationBasedValueRWModifier _modifier

std

public static final JacksonAnnotationExtension std

Extension instance configured with default settings.

Constructor Detail

JacksonAnnotationExtension

protected JacksonAnnotationExtension()

JacksonAnnotationExtension

protected JacksonAnnotationExtension(JacksonAnnotationExtension.Builder b)

Method Detail

builder

public static JacksonAnnotationExtension.Builder builder()

register

protected void register(com.fasterxml.jackson.jr.ob.api.ExtensionContext ctxt)

Specified by:

register in class com.fasterxml.jackson.jr.ob.JacksonJrExtension