Skip to content

Commit 3676be9

Browse files
cowtowncodercowtowncoder
authored
Implement #687: refactor XML read/write Feature names (#688)
1 parent ee34c8a commit 3676be9

28 files changed

+327
-317
lines changed

‎release-notes/VERSION

+2
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ Version: 3.x (for earlier see VERSION-2.x)
1010
#25: `ACCEPT_EMPTY_STRING_AS_NULL_OBJECT` not honored in xml module for attributes
1111
(reported by Morten-Olav H)
1212
#540: Rename "com.fasterxml.jackson" -> "tools.jackson"
13+
#687: JSTEP-8: rename `FromXmlParser.Feature` as `XmlReadFeature`,
14+
`ToXmlGenerator.Feature` as `XmlWriteFeature`
1315
- Add `XmlMapper.shared()`

‎src/main/java/tools/jackson/dataformat/xml/XmlFactory.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ public class XmlFactory
4343
* Bitfield (set of flags) of all parser features that are enabled
4444
* by default.
4545
*/
46-
final static int DEFAULT_XML_PARSER_FEATURE_FLAGS = FromXmlParser.Feature.collectDefaults();
46+
final static int DEFAULT_XML_PARSER_FEATURE_FLAGS = XmlReadFeature.collectDefaults();
4747

4848
/**
4949
* Bitfield (set of flags) of all generator features that are enabled
5050
* by default.
5151
*/
52-
final static int DEFAULT_XML_GENERATOR_FEATURE_FLAGS = ToXmlGenerator.Feature.collectDefaults();
52+
final static int DEFAULT_XML_GENERATOR_FEATURE_FLAGS = XmlWriteFeature.collectDefaults();
5353

5454
/*
5555
/**********************************************************************
@@ -301,13 +301,13 @@ public boolean canUseSchema(FormatSchema schema) {
301301
}
302302

303303
@Override
304-
public Class<FromXmlParser.Feature> getFormatReadFeatureType() {
305-
return FromXmlParser.Feature.class;
304+
public Class<XmlReadFeature> getFormatReadFeatureType() {
305+
return XmlReadFeature.class;
306306
}
307307

308308
@Override
309-
public Class<ToXmlGenerator.Feature> getFormatWriteFeatureType() {
310-
return ToXmlGenerator.Feature.class;
309+
public Class<XmlWriteFeature> getFormatWriteFeatureType() {
310+
return XmlWriteFeature.class;
311311
}
312312

313313
@Override

‎src/main/java/tools/jackson/dataformat/xml/XmlFactoryBuilder.java

+14-16
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
import tools.jackson.core.StreamReadConstraints;
99
import tools.jackson.core.StreamWriteConstraints;
1010
import tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder;
11-
import tools.jackson.dataformat.xml.deser.FromXmlParser;
12-
import tools.jackson.dataformat.xml.ser.ToXmlGenerator;
1311

1412
/**
1513
* {@link tools.jackson.core.TSFBuilder}
@@ -162,65 +160,65 @@ public XmlNameProcessor xmlNameProcessor() {
162160

163161
// // // Parser features
164162

165-
public XmlFactoryBuilder enable(FromXmlParser.Feature f) {
163+
public XmlFactoryBuilder enable(XmlReadFeature f) {
166164
_formatParserFeatures |= f.getMask();
167165
return _this();
168166
}
169167

170-
public XmlFactoryBuilder enable(FromXmlParser.Feature first, FromXmlParser.Feature... other) {
168+
public XmlFactoryBuilder enable(XmlReadFeature first, XmlReadFeature... other) {
171169
_formatParserFeatures |= first.getMask();
172-
for (FromXmlParser.Feature f : other) {
170+
for (XmlReadFeature f : other) {
173171
_formatParserFeatures |= f.getMask();
174172
}
175173
return _this();
176174
}
177175

178-
public XmlFactoryBuilder disable(FromXmlParser.Feature f) {
176+
public XmlFactoryBuilder disable(XmlReadFeature f) {
179177
_formatParserFeatures &= ~f.getMask();
180178
return _this();
181179
}
182180

183-
public XmlFactoryBuilder disable(FromXmlParser.Feature first, FromXmlParser.Feature... other) {
181+
public XmlFactoryBuilder disable(XmlReadFeature first, XmlReadFeature... other) {
184182
_formatParserFeatures &= ~first.getMask();
185-
for (FromXmlParser.Feature f : other) {
183+
for (XmlReadFeature f : other) {
186184
_formatParserFeatures &= ~f.getMask();
187185
}
188186
return _this();
189187
}
190188

191-
public XmlFactoryBuilder configure(FromXmlParser.Feature f, boolean state) {
189+
public XmlFactoryBuilder configure(XmlReadFeature f, boolean state) {
192190
return state ? enable(f) : disable(f);
193191
}
194192

195193
// // // Generator features
196194

197-
public XmlFactoryBuilder enable(ToXmlGenerator.Feature f) {
195+
public XmlFactoryBuilder enable(XmlWriteFeature f) {
198196
_formatGeneratorFeatures |= f.getMask();
199197
return _this();
200198
}
201199

202-
public XmlFactoryBuilder enable(ToXmlGenerator.Feature first, ToXmlGenerator.Feature... other) {
200+
public XmlFactoryBuilder enable(XmlWriteFeature first, XmlWriteFeature... other) {
203201
_formatGeneratorFeatures |= first.getMask();
204-
for (ToXmlGenerator.Feature f : other) {
202+
for (XmlWriteFeature f : other) {
205203
_formatGeneratorFeatures |= f.getMask();
206204
}
207205
return _this();
208206
}
209207

210-
public XmlFactoryBuilder disable(ToXmlGenerator.Feature f) {
208+
public XmlFactoryBuilder disable(XmlWriteFeature f) {
211209
_formatGeneratorFeatures &= ~f.getMask();
212210
return _this();
213211
}
214212

215-
public XmlFactoryBuilder disable(ToXmlGenerator.Feature first, ToXmlGenerator.Feature... other) {
213+
public XmlFactoryBuilder disable(XmlWriteFeature first, XmlWriteFeature... other) {
216214
_formatGeneratorFeatures &= ~first.getMask();
217-
for (ToXmlGenerator.Feature f : other) {
215+
for (XmlWriteFeature f : other) {
218216
_formatGeneratorFeatures &= ~f.getMask();
219217
}
220218
return _this();
221219
}
222220

223-
public XmlFactoryBuilder configure(ToXmlGenerator.Feature f, boolean state) {
221+
public XmlFactoryBuilder configure(XmlWriteFeature f, boolean state) {
224222
return state ? enable(f) : disable(f);
225223
}
226224

‎src/main/java/tools/jackson/dataformat/xml/XmlMapper.java

+10-10
Original file line numberDiff line numberDiff line change
@@ -181,21 +181,21 @@ public Builder activateDefaultTyping(PolymorphicTypeValidator ptv, DefaultTyping
181181
/******************************************************************
182182
*/
183183

184-
public Builder enable(FromXmlParser.Feature... features) {
185-
for (FromXmlParser.Feature f : features) {
184+
public Builder enable(XmlReadFeature... features) {
185+
for (XmlReadFeature f : features) {
186186
_formatReadFeatures |= f.getMask();
187187
}
188188
return this;
189189
}
190190

191-
public Builder disable(FromXmlParser.Feature... features) {
192-
for (FromXmlParser.Feature f : features) {
191+
public Builder disable(XmlReadFeature... features) {
192+
for (XmlReadFeature f : features) {
193193
_formatReadFeatures &= ~f.getMask();
194194
}
195195
return this;
196196
}
197197

198-
public Builder configure(FromXmlParser.Feature feature, boolean state)
198+
public Builder configure(XmlReadFeature feature, boolean state)
199199
{
200200
if (state) {
201201
_formatReadFeatures |= feature.getMask();
@@ -205,21 +205,21 @@ public Builder configure(FromXmlParser.Feature feature, boolean state)
205205
return this;
206206
}
207207

208-
public Builder enable(ToXmlGenerator.Feature... features) {
209-
for (ToXmlGenerator.Feature f : features) {
208+
public Builder enable(XmlWriteFeature... features) {
209+
for (XmlWriteFeature f : features) {
210210
_formatWriteFeatures |= f.getMask();
211211
}
212212
return this;
213213
}
214214

215-
public Builder disable(ToXmlGenerator.Feature... features) {
216-
for (ToXmlGenerator.Feature f : features) {
215+
public Builder disable(XmlWriteFeature... features) {
216+
for (XmlWriteFeature f : features) {
217217
_formatWriteFeatures &= ~f.getMask();
218218
}
219219
return this;
220220
}
221221

222-
public Builder configure(ToXmlGenerator.Feature feature, boolean state)
222+
public Builder configure(XmlWriteFeature feature, boolean state)
223223
{
224224
if (state) {
225225
_formatWriteFeatures |= feature.getMask();

‎src/main/java/tools/jackson/dataformat/xml/XmlReadFeature.java

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
package tools.jackson.dataformat.xml;
2+
3+
import javax.xml.XMLConstants;
4+
5+
import tools.jackson.core.FormatFeature;
6+
import tools.jackson.core.JsonToken;
7+
8+
/**
9+
* Enumeration that defines all togglable features for XML parsers.
10+
*<p>
11+
* NOTE: in Jackson 2.x this was named {@code FromXmlParser.Feature}.
12+
*/
13+
public enum XmlReadFeature implements FormatFeature
14+
{
15+
/**
16+
* Feature that enables automatic conversion of incoming "xsi:type"
17+
* (where "type" is the local name and "xsi" prefix is bound to URI
18+
* {@link XMLConstants#W3C_XML_SCHEMA_INSTANCE_NS_URI}),
19+
* into Jackson simple Property Name of {@code "xsi:type"}.
20+
* This is usually needed to read content written using
21+
* matching {@code ToXmlGenerator.Feature#AUTO_DETECT_XSI_TYPE} feature,
22+
* usually used for Polymorphic handling where it is difficult
23+
* to specify proper XML Namespace for type identifier.
24+
*<p>
25+
* Default setting is {@code false}.
26+
*/
27+
AUTO_DETECT_XSI_TYPE(false),
28+
29+
/**
30+
* Feature that indicates whether empty XML elements
31+
* (both empty tags like {@code <tag />} and {@code <tag></tag>}
32+
* (with no intervening cdata)
33+
* are exposed as {@link JsonToken#VALUE_NULL}) or not.
34+
* If they are not
35+
* returned as `null` tokens, they will be returned as {@link JsonToken#VALUE_STRING}
36+
* tokens with textual value of "" (empty String).
37+
*<p>
38+
* NOTE: in Jackson 2.x, only "true" empty tags were affected, not split ones.
39+
* With 3.x both cases handled uniformly.
40+
*<p>
41+
* Default setting is {@code false}.
42+
*/
43+
EMPTY_ELEMENT_AS_NULL(false),
44+
45+
/**
46+
* Feature that indicates whether XML Schema Instance attribute
47+
* {@code xsi:nil} will be processed automatically -- to indicate {@code null}
48+
* values -- or not.
49+
* If enabled, {@code xsi:nil} attribute on any XML element will mark such
50+
* elements as "null values" and any other attributes or child elements they
51+
* might have to be ignored. If disabled this attribute will be exposed like
52+
* any other attribute.
53+
*<p>
54+
* Default setting is {@code true}.
55+
*/
56+
PROCESS_XSI_NIL(true),
57+
58+
;
59+
60+
private final boolean _defaultState;
61+
private final int _mask;
62+
63+
/**
64+
* Method that calculates bit set (flags) of all features that
65+
* are enabled by default.
66+
*/
67+
public static int collectDefaults()
68+
{
69+
int flags = 0;
70+
for (XmlReadFeature f : values()) {
71+
if (f.enabledByDefault()) {
72+
flags |= f.getMask();
73+
}
74+
}
75+
return flags;
76+
}
77+
78+
private XmlReadFeature(boolean defaultState) {
79+
_defaultState = defaultState;
80+
_mask = (1 << ordinal());
81+
}
82+
83+
@Override public boolean enabledByDefault() { return _defaultState; }
84+
@Override public int getMask() { return _mask; }
85+
@Override public boolean enabledIn(int flags) { return (flags & getMask()) != 0; }
86+
}

0 commit comments

Comments
 (0)