com.fasterxml.jackson.jr.annotationsupport.JacksonAnnotationExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jackson-jr-annotation-support Show documentation
Additional package that adds support for a subset of Jackson core annotations from https://github.com/FasterXML/jackson-annotations
The newest version!
package com.fasterxml.jackson.jr.annotationsupport;

import com.fasterxml.jackson.annotation.JsonAutoDetect;

import com.fasterxml.jackson.jr.ob.JSON;
import com.fasterxml.jackson.jr.ob.JacksonJrExtension;
import com.fasterxml.jackson.jr.ob.api.ExtensionContext;

/**
 * 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)
 *  
 * {@link com.fasterxml.jackson.annotation.JsonIgnoreProperties}: supported on classes,
 *   but not on accessors
 *  
 * {@link com.fasterxml.jackson.annotation.JsonProperty} supported on accessors
 *  (fields, getters, setters) to specify explicit inclusion, name override. Other properties
 *  ({@code index}, {@code required}) not supported.
 *  
 * {@link com.fasterxml.jackson.annotation.JsonPropertyOrder}: supported on classes,
 *    but not on accessors
 *  
 * {@link com.fasterxml.jackson.annotation.JsonAutoDetect}: supported on classes
 *  
 *
 *
 * Usage is done by registering this extension with {@link JSON}, usually like:
 *
 *   JSON json = JSON.std.register(JacksonAnnotationExtension.builder()
 *       // possible configuration calls
 *       .build());
 *
 *
 * @since 2.11
 */
public class JacksonAnnotationExtension
    extends JacksonJrExtension
{
    /**
     * 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 {@code Visibility.PUBLIC_ONLY} for all other accessors
     * except for setters, for which {@code Visibility.ANY} is used.
     * In addition, following core settings are also considered:
     *

     * Fields: must also have {@link com.fasterxml.jackson.jr.ob.JSON.Feature#USE_FIELDS} enabled
     *    otherwise {@code Visibility.NONE} is used
     *  
     * Is-getters: must also have {@link com.fasterxml.jackson.jr.ob.JSON.Feature#USE_IS_GETTERS} enabled
     *    otherwise {@code Visibility.NONE} is used
     *  
     * Creators: never auto-detected so setting irrelevant
     *  
     *
     */
    public final static JsonAutoDetect.Value DEFAULT_VISIBILITY =
            JsonAutoDetect.Value.construct(
                    JsonAutoDetect.Visibility.PUBLIC_ONLY, // fields
                    JsonAutoDetect.Visibility.PUBLIC_ONLY, // getters
                    JsonAutoDetect.Visibility.PUBLIC_ONLY, // isGetters
                    JsonAutoDetect.Visibility.PUBLIC_ONLY, // setters
                    JsonAutoDetect.Visibility.NONE // creator
            );

    /**
     * Builder class for configuring resulting {@link JacksonAnnotationExtension}.
     */
    public static class Builder
    {
        public JsonAutoDetect.Value visibility = DEFAULT_VISIBILITY;

        public JacksonAnnotationExtension build() {
            return new JacksonAnnotationExtension(this);
        }

        /**
         * Method for setting visibility settings to specified parameter and returning
         * resulting builder instance.
         *
         * @param allVisibility Visibility settings to use, or {@code null} to indicate
         *    "use default visibility" (see {@link JacksonAnnotationExtension#DEFAULT_VISIBILITY}).
         *
         * @return Builder with specified visibility settings
         */
        public Builder withVisibility(JsonAutoDetect.Value allVisibility) {
            visibility = (allVisibility == null) ? DEFAULT_VISIBILITY : allVisibility;
            return this;
        }
    }

    protected final AnnotationBasedValueRWModifier _modifier;

    /**
     * Extension instance configured with default settings.
     */
    public final static JacksonAnnotationExtension std = new JacksonAnnotationExtension();
    
    protected JacksonAnnotationExtension() {
        _modifier = new AnnotationBasedValueRWModifier(DEFAULT_VISIBILITY);
    }

    protected JacksonAnnotationExtension(Builder b) {
        _modifier = new AnnotationBasedValueRWModifier(b.visibility);
    }

    public static Builder builder() {
        return new Builder();
    }

    @Override
    protected void register(ExtensionContext ctxt) {
        ctxt.insertModifier(_modifier);
    }
}