Debian Codegraph @

jr-annotation-support/src/main/java/com/fasterxml/jackson/jr/annotationsupport/JacksonAnnotationExtension.java

raw
1 package com.fasterxml.jackson.jr.annotationsupport;
2
3 import com.fasterxml.jackson.annotation.JsonAutoDetect;
4
5 import com.fasterxml.jackson.jr.ob.JSON;
6 import com.fasterxml.jackson.jr.ob.JacksonJrExtension;
7 import com.fasterxml.jackson.jr.ob.api.ExtensionContext;
8
9 /**
10 * Helper object that provides limited support for Jackson core annotations.
11 *<p>
12 * Set of annotations supported includes:
13 *<ul>
14 * <li>{link com.fasterxml.jackson.annotation.JsonAlias}: supported on accessors
15 * (fields, getters, setters)
16 * </li>
17 * <li>{link com.fasterxml.jackson.annotation.JsonIgnore}: supported on accessors
18 * (fields, getters, setters)
19 * </li>
20 * <li>{@link com.fasterxml.jackson.annotation.JsonIgnoreProperties}: supported on classes,
21 * but not on accessors
22 * </li>
23 * <li>{@link com.fasterxml.jackson.annotation.JsonProperty} supported on accessors
24 * (fields, getters, setters) to specify explicit inclusion, name override. Other properties
25 * ({@code index}, {@code required}) not supported.
26 * </li>
27 * <li>{@link com.fasterxml.jackson.annotation.JsonPropertyOrder}: supported on classes,
28 * but not on accessors
29 * </li>
30 * <li>{@link com.fasterxml.jackson.annotation.JsonAutoDetect}: supported on classes
31 * </li>
32 *</ul>
33 *<p>
34 * Usage is done by registering this extension with {@link JSON}, usually like:
35 *<pre>
36 * JSON json = JSON.std.register(JacksonAnnotationExtension.builder()
37 * // possible configuration calls
38 * .build());
39 *</pre>
40 *
41 * @since 2.11
42 */
43 public class JacksonAnnotationExtension
44 extends JacksonJrExtension
45 {
46 /**
47 * Default visibility settings for Jackson-jr: in addition to being defaults commonly
48 * used as the base for creating alternative settings. For example,
49 * to allow auto-detection of ALL fields regardless visibility, but none
50 * of setters (without annotation) you could use
51 *<pre>
52 * JacksonAnnotationExtension ext = JacksonAnnotationExtension.builder()
53 * .withVisibility(JacksonAnnotationExtension.DEFAULT_VISIBILITY
54 * .withFieldVisibility(Visibility.ANY)
55 * .withSetterVisibility(Visibility.NONE)
56 * ).build();
57 *</pre>
58 *<p>
59 * Default visibility settings are {@code Visibility.PUBLIC_ONLY} for all other accessors
60 * except for setters, for which {@code Visibility.ANY} is used.
61 * In addition, following core settings are also considered:
62 *<ul>
63 * <li>Fields: must also have {@link com.fasterxml.jackson.jr.ob.JSON.Feature#USE_FIELDS} enabled
64 * otherwise {@code Visibility.NONE} is used
65 * </li>
66 * <li>Is-getters: must also have {@link com.fasterxml.jackson.jr.ob.JSON.Feature#USE_IS_GETTERS} enabled
67 * otherwise {@code Visibility.NONE} is used
68 * </li>
69 * <li>Creators: never auto-detected so setting irrelevant
70 * </li>
71 *</ul>
72 */
73 public final static JsonAutoDetect.Value DEFAULT_VISIBILITY =
74 JsonAutoDetect.Value.construct(
75 JsonAutoDetect.Visibility.PUBLIC_ONLY, // fields
76 JsonAutoDetect.Visibility.PUBLIC_ONLY, // getters
77 JsonAutoDetect.Visibility.PUBLIC_ONLY, // isGetters
78 JsonAutoDetect.Visibility.PUBLIC_ONLY, // setters
79 JsonAutoDetect.Visibility.NONE // creator
80 );
81
82 /**
83 * Builder class for configuring resulting {@link JacksonAnnotationExtension}.
84 */
85 public static class Builder
86 {
87 public JsonAutoDetect.Value visibility = DEFAULT_VISIBILITY;
88
89 public JacksonAnnotationExtension build() {
90 return new JacksonAnnotationExtension(this);
91 }
92
93 /**
94 * Method for setting visibility settings to specified parameter and returning
95 * resulting builder instance.
96 *
97 * @param allVisibility Visibility settings to use, or {@code null} to indicate
98 * "use default visibility" (see {@link JacksonAnnotationExtension#DEFAULT_VISIBILITY}).
99 *
100 * @return Builder with specified visibility settings
101 */
102 public Builder withVisibility(JsonAutoDetect.Value allVisibility) {
103 visibility = (allVisibility == null) ? DEFAULT_VISIBILITY : allVisibility;
104 return this;
105 }
106 }
107
108 protected final AnnotationBasedValueRWModifier _modifier;
109
110 /**
111 * Extension instance configured with default settings.
112 */
113 public final static JacksonAnnotationExtension std = new JacksonAnnotationExtension();
114
115 protected JacksonAnnotationExtension() {
116 _modifier = new AnnotationBasedValueRWModifier(DEFAULT_VISIBILITY);
117 }
118
119 protected JacksonAnnotationExtension(Builder b) {
120 _modifier = new AnnotationBasedValueRWModifier(b.visibility);
121 }
122
123 public static Builder builder() {
124 return new Builder();
125 }
126
127 @Override
128 protected void register(ExtensionContext ctxt) {
129 ctxt.insertModifier(_modifier);
130 }
131 }