Debian Codegraph @

jr-annotation-support/src/test/java/com/fasterxml/jackson/jr/annotationsupport/BasicVisibilityTest.java

raw
1 package com.fasterxml.jackson.jr.annotationsupport;
2
3 import com.fasterxml.jackson.annotation.JsonAutoDetect;
4 import com.fasterxml.jackson.jr.ob.JSON;
5
6 public class BasicVisibilityTest extends ASTestBase
7 {
8 static class FieldXYZ {
9 public int x;
10 protected int y;
11 private int z;
12
13 protected FieldXYZ() { }
14 public FieldXYZ(int x, int y, int z) {
15 this.x = x;
16 this.y = y;
17 this.z = z;
18 }
19
20 public int x() { return x; }
21 public int y() { return y; }
22 public int z() { return z; }
23 }
24
25 static class FieldXYTransient {
26 public int x;
27 public transient int y;
28
29 protected FieldXYTransient() { }
30 public FieldXYTransient(int x, int y) {
31 this.x = x;
32 this.y = y;
33 }
34 }
35
36 @JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.PROTECTED_AND_PUBLIC)
37 static class FieldXYZWithAnnotation {
38 public int x;
39 protected int y;
40 private int z;
41
42 protected FieldXYZWithAnnotation() { }
43 public FieldXYZWithAnnotation(int x, int y, int z) {
44 this.x = x;
45 this.y = y;
46 this.z = z;
47 }
48
49 public int x() { return x; }
50 public int y() { return y; }
51 public int z() { return z; }
52 }
53
54 static class MethodXYEnabled {
55 int _x;
56 int _y;
57 boolean _enabled;
58
59 protected MethodXYEnabled() { }
60 public MethodXYEnabled(int x, int y, boolean enabled) {
61 _x = x;
62 _y = y;
63 _enabled = enabled;
64 }
65
66 public int getX() { return _x; }
67 protected int getY() { return _y; }
68 protected boolean isEnabled() { return _enabled; }
69
70 public void setX(int x) { _x = x; }
71 protected void setY(int y) { _y = y; }
72 protected void setEnabled(boolean enabled) { _enabled = enabled; }
73 }
74
75 // Increase getter/is-getter levels to "protected", decrease setter
76 // to require public
77 @JsonAutoDetect(setterVisibility = JsonAutoDetect.Visibility.PUBLIC_ONLY,
78 getterVisibility = JsonAutoDetect.Visibility.PROTECTED_AND_PUBLIC,
79 isGetterVisibility = JsonAutoDetect.Visibility.PROTECTED_AND_PUBLIC
80 )
81 static class MethodXYEnabledWithAnnotations {
82 int _x;
83 int _y;
84 boolean _enabled;
85
86 protected MethodXYEnabledWithAnnotations() { }
87 public MethodXYEnabledWithAnnotations(int x, int y, boolean enabled) {
88 _x = x;
89 _y = y;
90 _enabled = enabled;
91 }
92
93 public int getX() { return _x; }
94 protected int getY() { return _y; }
95 protected boolean isEnabled() { return _enabled; }
96
97 public void setX(int x) { _x = x; }
98 protected void setY(int y) { _y = y; }
99 protected void setEnabled(boolean enabled) { _enabled = enabled; }
100 }
101
102 private final JsonAutoDetect.Value VIS_FIELD_PROTECTED = JacksonAnnotationExtension.DEFAULT_VISIBILITY
103 .withFieldVisibility(JsonAutoDetect.Visibility.PROTECTED_AND_PUBLIC);
104
105 private final JsonAutoDetect.Value VIS_FIELD_ALL = JacksonAnnotationExtension.DEFAULT_VISIBILITY
106 .withFieldVisibility(JsonAutoDetect.Visibility.ANY);
107
108 private final JsonAutoDetect.Value VIS_SETTER_PUBLIC = JacksonAnnotationExtension.DEFAULT_VISIBILITY
109 .withSetterVisibility(JsonAutoDetect.Visibility.PUBLIC_ONLY);
110
111 private final JsonAutoDetect.Value VIS_REGULAR_GETTER_PROTECTED = JacksonAnnotationExtension.DEFAULT_VISIBILITY
112 .withGetterVisibility(JsonAutoDetect.Visibility.PROTECTED_AND_PUBLIC);
113
114 private final JsonAutoDetect.Value VIS_IS_GETTER_PROTECTED = JacksonAnnotationExtension.DEFAULT_VISIBILITY
115 .withIsGetterVisibility(JsonAutoDetect.Visibility.PROTECTED_AND_PUBLIC);
116
117 /*
118 /**********************************************************************
119 /* Test methods, field visibility
120 /**********************************************************************
121 */
122
123 public void testSimpleSerializeFieldVisibility() throws Exception
124 {
125 final FieldXYZ input = new FieldXYZ(1, 2, 3);
126 // by default, only public field seen
127 assertEquals(a2q("{'x':1}"), JSON.std.asString(input));
128 // but various levels increase it
129 assertEquals(a2q("{'x':1,'y':2}"), jsonWithVisibility(VIS_FIELD_PROTECTED)
130 .asString(input));
131 assertEquals(a2q("{'x':1,'y':2,'z':3}"), jsonWithVisibility(VIS_FIELD_ALL)
132 .asString(input));
133
134 // but must have fields enabled (handled in core jr-objects, not by annotations)
135 assertEquals(a2q("{}"),
136 jsonWithVisibility(VIS_FIELD_ALL)
137 .without(JSON.Feature.USE_FIELDS)
138 .asString(input));
139
140 // finally, consider class annotation version
141 assertEquals(a2q("{'x':1,'y':2}"), jsonWithVisibility(null)
142 .asString(new FieldXYZWithAnnotation(1, 2, 3)));
143 }
144
145 // Test to ensure we will not attempt deserializing transient fields
146 public void testSimpleSerializeWrtTransient() throws Exception
147 {
148 final FieldXYTransient input = new FieldXYTransient(1, 2);
149
150 // Alas, by default, jackson-jr does not skip transient
151 assertEquals(a2q("{'x':1,'y':2}"), JSON.std.asString(input));
152
153 // but with extension it does
154 assertEquals(a2q("{'x':1}"), jsonWithVisibility(VIS_FIELD_PROTECTED)
155 .asString(input));
156 assertEquals(a2q("{'x':1}"), jsonWithVisibility(null)
157 .asString(input));
158 }
159
160 public void testSimpleDeserializeFieldVisibility() throws Exception
161 {
162 final String input = a2q("{'x':1,'y':2,'z':3}");
163 FieldXYZ result;
164
165 // by default only 'x' visible:
166 result = JSON.std.beanFrom(FieldXYZ.class, input);
167 assertEquals(1, result.x());
168 assertEquals(0, result.y());
169 assertEquals(0, result.z());
170
171 // but changes with minimum visibility
172 result = jsonWithVisibility(VIS_FIELD_PROTECTED).beanFrom(FieldXYZ.class, input);
173 assertEquals(1, result.x());
174 assertEquals(2, result.y());
175 assertEquals(0, result.z());
176
177 result = jsonWithVisibility(VIS_FIELD_ALL).beanFrom(FieldXYZ.class, input);
178 assertEquals(1, result.x());
179 assertEquals(2, result.y());
180 assertEquals(3, result.z());
181 }
182
183 // Test to ensure we will not attempt deserializing transient fields
184 public void testSimpleDeserializeWrtTransient() throws Exception
185 {
186 final String input = a2q("{'x':1,'y':2}");
187 FieldXYTransient result;
188
189 // Alas, by default, jackson-jr does not skip transient
190 result = JSON.std.beanFrom(FieldXYTransient.class, input);
191 assertEquals(1, result.x);
192 // assertEquals(0, result.y);
193
194 // but visibility settings, should
195 result = jsonWithVisibility(VIS_FIELD_ALL).beanFrom(FieldXYTransient.class, input);
196 assertEquals(1, result.x);
197 assertEquals(0, result.y);
198 }
199
200 /*
201 /**********************************************************************
202 /* Test methods, getter visibility (serialization)
203 /**********************************************************************
204 */
205
206 public void testSimpleGetterVisibility() throws Exception
207 {
208 final MethodXYEnabled input = new MethodXYEnabled(1, 2, true);
209 // by default, only public field seen
210 assertEquals(a2q("{'x':1}"), JSON.std.asString(input));
211 // but various levels increase it
212 assertEquals(a2q("{'x':1,'y':2}"), jsonWithVisibility(VIS_REGULAR_GETTER_PROTECTED)
213 .asString(input));
214 assertEquals(a2q("{'enabled':true,'x':1}"), jsonWithVisibility(VIS_IS_GETTER_PROTECTED)
215 .asString(input));
216 }
217
218 public void testSimpleGetterWithAnnotationVisibility() throws Exception
219 {
220 final MethodXYEnabledWithAnnotations input = new MethodXYEnabledWithAnnotations(1, 2, true);
221 assertEquals(a2q("{'enabled':true,'x':1,'y':2}"), jsonWithVisibility(null)
222 .asString(input));
223 }
224
225 /*
226 /**********************************************************************
227 /* Test methods, setter visibility (deserialization)
228 /**********************************************************************
229 */
230
231 public void testSimpleSetterVisibility() throws Exception
232 {
233 final String input = a2q("{'enabled':true,'x':1,'y':2}");
234 MethodXYEnabled result;
235
236 // 25-Jan-2020, tatu: by default even non-public setters are actually found as of 2.10
237 // so need to keep behavior the same
238 result = JSON.std.beanFrom(MethodXYEnabled.class, input);
239 assertEquals(1, result._x);
240 assertEquals(2, result._y);
241 assertEquals(true, result._enabled);
242
243 // but when defining visibility with detection settings, can change
244 result = jsonWithVisibility(VIS_SETTER_PUBLIC).beanFrom(MethodXYEnabled.class, input);
245 assertEquals(1, result._x);
246 assertEquals(0, result._y);
247 assertEquals(false, result._enabled);
248 }
249
250 public void testSimpleSetterWithAnnotationVisibility() throws Exception
251 {
252 final String input = a2q("{'enabled':true,'x':1,'y':2}");
253 MethodXYEnabledWithAnnotations result;
254
255 // 25-Jan-2020, tatu: by default even non-public setters are actually found as of 2.10
256 // so need to keep behavior the same
257 result = jsonWithVisibility(null).beanFrom(MethodXYEnabledWithAnnotations.class, input);
258 assertEquals(1, result._x);
259 assertEquals(0, result._y);
260 assertEquals(false, result._enabled);
261 }
262
263 /*
264 /**********************************************************************
265 /* Helper methods
266 /**********************************************************************
267 */
268
269 private JSON jsonWithVisibility(JsonAutoDetect.Value vis) {
270 return JSON.builder()
271 .register(JacksonAnnotationExtension.builder()
272 .withVisibility(vis)
273 .build())
274 .build();
275 }
276 }