Skip to content

Commit 57155b9

Browse files
cowtowncodercowtowncoder
authored
Implement #526: rename Ion read/write features (JSTEP-8) (#527)
1 parent 5119905 commit 57155b9

File tree

12 files changed

+151
-143
lines changed

12 files changed

+151
-143
lines changed

‎ion/src/main/java/tools/jackson/dataformat/ion/IonFactory.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ public class IonFactory
6161
* Bitfield (set of flags) of all parser features that are enabled
6262
* by default.
6363
*/
64-
protected final static int DEFAULT_ION_PARSER_FEATURE_FLAGS = IonParser.Feature.collectDefaults();
64+
protected final static int DEFAULT_ION_PARSER_FEATURE_FLAGS = IonReadFeature.collectDefaults();
6565

6666
/**
6767
* Bitfield (set of flags) of all generator features that are enabled
6868
* by default.
6969
*/
70-
protected final static int DEFAULT_ION_GENERATOR_FEATURE_FLAGS = IonGenerator.Feature.collectDefaults();
70+
protected final static int DEFAULT_ION_GENERATOR_FEATURE_FLAGS = IonWriteFeature.collectDefaults();
7171

7272
/*
7373
/**********************************************************************
@@ -206,14 +206,14 @@ public boolean canHandleBinaryNatively() {
206206
/**
207207
* Checked whether specified parser feature is enabled.
208208
*/
209-
public final boolean isEnabled(IonParser.Feature f) {
209+
public final boolean isEnabled(IonReadFeature f) {
210210
return (_formatReadFeatures & f.getMask()) != 0;
211211
}
212212

213213
/**
214214
* Check whether specified generator feature is enabled.
215215
*/
216-
public final boolean isEnabled(IonGenerator.Feature f) {
216+
public final boolean isEnabled(IonWriteFeature f) {
217217
return (_formatWriteFeatures & f.getMask()) != 0;
218218
}
219219

@@ -234,13 +234,13 @@ public boolean canUseSchema(FormatSchema schema) {
234234
}
235235

236236
@Override
237-
public Class<IonParser.Feature> getFormatReadFeatureType() {
238-
return IonParser.Feature.class;
237+
public Class<IonReadFeature> getFormatReadFeatureType() {
238+
return IonReadFeature.class;
239239
}
240240

241241
@Override
242-
public Class<IonGenerator.Feature> getFormatWriteFeatureType() {
243-
return IonGenerator.Feature.class;
242+
public Class<IonWriteFeature> getFormatWriteFeatureType() {
243+
return IonWriteFeature.class;
244244
}
245245

246246
/*

‎ion/src/main/java/tools/jackson/dataformat/ion/IonFactoryBuilder.java‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,65 +85,65 @@ public IonFactoryBuilder ionSystem(IonSystem system) {
8585

8686
// // // Parser features
8787

88-
public IonFactoryBuilder enable(IonParser.Feature f) {
88+
public IonFactoryBuilder enable(IonReadFeature f) {
8989
_formatReadFeatures |= f.getMask();
9090
return _this();
9191
}
9292

93-
public IonFactoryBuilder enable(IonParser.Feature first, IonParser.Feature... other) {
93+
public IonFactoryBuilder enable(IonReadFeature first, IonReadFeature... other) {
9494
_formatReadFeatures |= first.getMask();
95-
for (IonParser.Feature f : other) {
95+
for (IonReadFeature f : other) {
9696
_formatReadFeatures |= f.getMask();
9797
}
9898
return _this();
9999
}
100100

101-
public IonFactoryBuilder disable(IonParser.Feature f) {
101+
public IonFactoryBuilder disable(IonReadFeature f) {
102102
_formatReadFeatures &= ~f.getMask();
103103
return _this();
104104
}
105105

106-
public IonFactoryBuilder disable(IonParser.Feature first, IonParser.Feature... other) {
106+
public IonFactoryBuilder disable(IonReadFeature first, IonReadFeature... other) {
107107
_formatReadFeatures &= ~first.getMask();
108-
for (IonParser.Feature f : other) {
108+
for (IonReadFeature f : other) {
109109
_formatReadFeatures &= ~f.getMask();
110110
}
111111
return _this();
112112
}
113113

114-
public IonFactoryBuilder configure(IonParser.Feature f, boolean state) {
114+
public IonFactoryBuilder configure(IonReadFeature f, boolean state) {
115115
return state ? enable(f) : disable(f);
116116
}
117117

118118
// // // Generator features
119119

120-
public IonFactoryBuilder enable(IonGenerator.Feature f) {
120+
public IonFactoryBuilder enable(IonWriteFeature f) {
121121
_formatWriteFeatures |= f.getMask();
122122
return _this();
123123
}
124124

125-
public IonFactoryBuilder enable(IonGenerator.Feature first, IonGenerator.Feature... other) {
125+
public IonFactoryBuilder enable(IonWriteFeature first, IonWriteFeature... other) {
126126
_formatWriteFeatures |= first.getMask();
127-
for (IonGenerator.Feature f : other) {
127+
for (IonWriteFeature f : other) {
128128
_formatWriteFeatures |= f.getMask();
129129
}
130130
return _this();
131131
}
132132

133-
public IonFactoryBuilder disable(IonGenerator.Feature f) {
133+
public IonFactoryBuilder disable(IonWriteFeature f) {
134134
_formatWriteFeatures &= ~f.getMask();
135135
return _this();
136136
}
137137

138-
public IonFactoryBuilder disable(IonGenerator.Feature first, IonGenerator.Feature... other) {
138+
public IonFactoryBuilder disable(IonWriteFeature first, IonWriteFeature... other) {
139139
_formatWriteFeatures &= ~first.getMask();
140-
for (IonGenerator.Feature f : other) {
140+
for (IonWriteFeature f : other) {
141141
_formatWriteFeatures &= ~f.getMask();
142142
}
143143
return _this();
144144
}
145145

146-
public IonFactoryBuilder configure(IonGenerator.Feature f, boolean state) {
146+
public IonFactoryBuilder configure(IonWriteFeature f, boolean state) {
147147
return state ? enable(f) : disable(f);
148148
}
149149

‎ion/src/main/java/tools/jackson/dataformat/ion/IonGenerator.java‎

Lines changed: 2 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -40,58 +40,6 @@
4040
public class IonGenerator
4141
extends GeneratorBase
4242
{
43-
/**
44-
* Enumeration that defines all toggleable features for Ion generators
45-
*/
46-
public enum Feature implements FormatFeature
47-
{
48-
/**
49-
* Whether to use Ion native Type Id construct for indicating type (true);
50-
* or "generic" type property (false) when writing. Former works better for
51-
* systems that are Ion-centric; latter may be better choice for interoperability,
52-
* when converting between formats or accepting other formats.
53-
*<p>
54-
* Enabled by default for backwards compatibility as that has been the behavior
55-
* of `jackson-dataformat-ion` since 2.9 (first official public version)
56-
*
57-
* @see <a href="https://amzn.github.io/ion-docs/docs/spec.html#annot">The Ion Specification</a>
58-
*
59-
* @since 2.12
60-
*/
61-
USE_NATIVE_TYPE_ID(true),
62-
;
63-
64-
protected final boolean _defaultState;
65-
protected final int _mask;
66-
67-
/**
68-
* Method that calculates bit set (flags) of all features that
69-
* are enabled by default.
70-
*/
71-
public static int collectDefaults()
72-
{
73-
int flags = 0;
74-
for (Feature f : values()) {
75-
if (f.enabledByDefault()) {
76-
flags |= f.getMask();
77-
}
78-
}
79-
return flags;
80-
}
81-
82-
private Feature(boolean defaultState) {
83-
_defaultState = defaultState;
84-
_mask = (1 << ordinal());
85-
}
86-
87-
@Override
88-
public boolean enabledByDefault() { return _defaultState; }
89-
@Override
90-
public boolean enabledIn(int flags) { return (flags & _mask) != 0; }
91-
@Override
92-
public int getMask() { return _mask; }
93-
}
94-
9543
/*
9644
/**********************************************************************
9745
/* Basic configuration
@@ -105,7 +53,7 @@ private Feature(boolean defaultState) {
10553

10654
/**
10755
* Bit flag composed of bits that indicate which
108-
* {@link IonGenerator.Feature}s
56+
* {@link IonWriteFeature}s
10957
* are enabled.
11058
*/
11159
protected int _formatFeatures;
@@ -239,7 +187,7 @@ public void flush()
239187
public boolean canWriteTypeId() {
240188
// yes, Ion does support Native Type Ids!
241189
// 29-Nov-2020, jobarr: Except as per [dataformats-binary#225] might not want to...
242-
return Feature.USE_NATIVE_TYPE_ID.enabledIn(_formatFeatures);
190+
return IonWriteFeature.USE_NATIVE_TYPE_ID.enabledIn(_formatFeatures);
243191
}
244192

245193
@Override

‎ion/src/main/java/tools/jackson/dataformat/ion/IonObjectMapper.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -91,21 +91,21 @@ protected MapperBuilderState _saveState() {
9191
/******************************************************************
9292
*/
9393

94-
public Builder enable(IonParser.Feature... features) {
95-
for (IonParser.Feature f : features) {
94+
public Builder enable(IonReadFeature... features) {
95+
for (IonReadFeature f : features) {
9696
_formatReadFeatures |= f.getMask();
9797
}
9898
return this;
9999
}
100100

101-
public Builder disable(IonParser.Feature... features) {
102-
for (IonParser.Feature f : features) {
101+
public Builder disable(IonReadFeature... features) {
102+
for (IonReadFeature f : features) {
103103
_formatReadFeatures &= ~f.getMask();
104104
}
105105
return this;
106106
}
107107

108-
public Builder configure(IonParser.Feature feature, boolean state)
108+
public Builder configure(IonReadFeature feature, boolean state)
109109
{
110110
if (state) {
111111
_formatReadFeatures |= feature.getMask();
@@ -115,21 +115,21 @@ public Builder configure(IonParser.Feature feature, boolean state)
115115
return this;
116116
}
117117

118-
public Builder enable(IonGenerator.Feature... features) {
119-
for (IonGenerator.Feature f : features) {
118+
public Builder enable(IonWriteFeature... features) {
119+
for (IonWriteFeature f : features) {
120120
_formatWriteFeatures |= f.getMask();
121121
}
122122
return this;
123123
}
124124

125-
public Builder disable(IonGenerator.Feature... features) {
126-
for (IonGenerator.Feature f : features) {
125+
public Builder disable(IonWriteFeature... features) {
126+
for (IonWriteFeature f : features) {
127127
_formatWriteFeatures &= ~f.getMask();
128128
}
129129
return this;
130130
}
131131

132-
public Builder configure(IonGenerator.Feature feature, boolean state)
132+
public Builder configure(IonWriteFeature feature, boolean state)
133133
{
134134
if (state) {
135135
_formatWriteFeatures |= feature.getMask();

‎ion/src/main/java/tools/jackson/dataformat/ion/IonParser.java‎

Lines changed: 2 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -36,54 +36,6 @@
3636
public class IonParser
3737
extends ParserMinimalBase
3838
{
39-
/**
40-
* Enumeration that defines all togglable features for Ion parsers.
41-
*/
42-
public enum Feature implements FormatFeature
43-
{
44-
/**
45-
* Whether to expect Ion native Type Id construct for indicating type (true);
46-
* or "generic" type property (false) when deserializing.
47-
*<p>
48-
* Enabled by default for backwards compatibility as that has been the behavior
49-
* of `jackson-dataformat-ion` since 2.9 (first official public version)
50-
*
51-
* @see <a href="https://amzn.github.io/ion-docs/docs/spec.html#annot">The Ion Specification</a>
52-
*/
53-
USE_NATIVE_TYPE_ID(true),
54-
;
55-
56-
final boolean _defaultState;
57-
final int _mask;
58-
59-
/**
60-
* Method that calculates bit set (flags) of all features that
61-
* are enabled by default.
62-
*/
63-
public static int collectDefaults()
64-
{
65-
int flags = 0;
66-
for (Feature f : values()) {
67-
if (f.enabledByDefault()) {
68-
flags |= f.getMask();
69-
}
70-
}
71-
return flags;
72-
}
73-
74-
private Feature(boolean defaultState) {
75-
_defaultState = defaultState;
76-
_mask = (1 << ordinal());
77-
}
78-
79-
@Override
80-
public boolean enabledByDefault() { return _defaultState; }
81-
@Override
82-
public boolean enabledIn(int flags) { return (flags & _mask) != 0; }
83-
@Override
84-
public int getMask() { return _mask; }
85-
}
86-
8739
// @since 2.14
8840
protected final static JacksonFeatureSet<StreamReadCapability> ION_READ_CAPABILITIES
8941
= DEFAULT_READ_CAPABILITIES.with(StreamReadCapability.EXACT_FLOATS);
@@ -100,7 +52,7 @@ private Feature(boolean defaultState) {
10052

10153
/**
10254
* Bit flag composed of bits that indicate which
103-
* {@link IonParser.Feature}s are enabled.
55+
* {@link IonReadFeature}s are enabled.
10456
*/
10557
protected int _formatFeatures;
10658

@@ -173,7 +125,7 @@ public IOContext ioContext() {
173125
public boolean canReadTypeId() {
174126
// yes, Ion got 'em
175127
// 31-Mar-2021, manaigrn: but we might want to ignore them as per [dataformats-binary#270]
176-
return Feature.USE_NATIVE_TYPE_ID.enabledIn(_formatFeatures);
128+
return IonReadFeature.USE_NATIVE_TYPE_ID.enabledIn(_formatFeatures);
177129
}
178130

179131
@Override

‎ion/src/main/java/tools/jackson/dataformat/ion/IonReadFeature.java‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
package tools.jackson.dataformat.ion;
2+
3+
import tools.jackson.core.FormatFeature;
4+
5+
/**
6+
* Enumeration that defines all togglable features for Ion parsers.
7+
*<p>
8+
* NOTE: in Jackson 2.x this was named {@code IonParser.Feature}.
9+
*/
10+
public enum IonReadFeature implements FormatFeature
11+
{
12+
/**
13+
* Whether to expect Ion native Type Id construct for indicating type (true);
14+
* or "generic" type property (false) when deserializing.
15+
*<p>
16+
* Enabled by default.
17+
*
18+
* @see <a href="https://amzn.github.io/ion-docs/docs/spec.html#annot">The Ion Specification</a>
19+
*/
20+
USE_NATIVE_TYPE_ID(true),
21+
;
22+
23+
private final boolean _defaultState;
24+
private final int _mask;
25+
26+
/**
27+
* Method that calculates bit set (flags) of all features that
28+
* are enabled by default.
29+
*/
30+
public static int collectDefaults()
31+
{
32+
int flags = 0;
33+
for (IonReadFeature f : values()) {
34+
if (f.enabledByDefault()) {
35+
flags |= f.getMask();
36+
}
37+
}
38+
return flags;
39+
}
40+
41+
private IonReadFeature(boolean defaultState) {
42+
_defaultState = defaultState;
43+
_mask = (1 << ordinal());
44+
}
45+
46+
@Override
47+
public boolean enabledByDefault() { return _defaultState; }
48+
@Override
49+
public boolean enabledIn(int flags) { return (flags & _mask) != 0; }
50+
@Override
51+
public int getMask() { return _mask; }
52+
}

0 commit comments

Comments
 (0)