Skip to content

Commit f0aa287

Browse files
cowtowncodercowtowncoder
committed
Implement #512: refactory YAML read/write features
1 parent 50782ec commit f0aa287

23 files changed

+317
-313
lines changed

‎release-notes/VERSION

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ implementations)
2222
(suggested by @SebastianSolidwork)
2323
#510: JSTEP-8: rename `CsvParser.Feature` as `CsvReadFeature`,
2424
`CsvGenerator.Feature` as `CsvWriteFeature`
25+
#512: JSTEP-8: rename `YAMLParser.Feature` as `YAMLReadFeature`,
26+
`YAMLGenerator.Feature` as `YAMLWriteFeature`
2527
- Add `XxxMapper.shared()` methods for getting globally shared default instances
2628

2729
CSV:

‎toml/src/main/java/tools/jackson/dataformat/toml/TomlReadFeature.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
* Enumeration that defines all togglable features for TOML parsers.
77
*/
88
public enum TomlReadFeature
9-
implements FormatFeature {
9+
implements FormatFeature
10+
{
1011
/**
1112
* TOML has special syntax for time types corresponding to {@link java.time.LocalDate}, {@link java.time.LocalTime},
1213
* {@link java.time.LocalDateTime} and {@link java.time.OffsetDateTime}. By default, the TOML parser just returns
@@ -17,8 +18,8 @@ public enum TomlReadFeature
1718
*/
1819
PARSE_JAVA_TIME(false);
1920

20-
final boolean _defaultState;
21-
final int _mask;
21+
private final boolean _defaultState;
22+
private final int _mask;
2223

2324
// Method that calculates bit set (flags) of all features that
2425
// are enabled by default.

‎toml/src/main/java/tools/jackson/dataformat/toml/TomlWriteFeature.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
/**
77
* Enumeration that defines all togglable features for TOML generators.
88
*/
9-
public enum TomlWriteFeature implements FormatFeature {
9+
public enum TomlWriteFeature implements FormatFeature
10+
{
1011
/**
1112
* The TOML spec does not allow null values. We instead write an empty string when
1213
* {@link JsonGenerator#writeNull()} by default.
@@ -20,8 +21,8 @@ public enum TomlWriteFeature implements FormatFeature {
2021
*/
2122
static final int INTERNAL_PROHIBIT_INTERNAL_BUFFER_ALLOCATE = 0x80000000;
2223

23-
final boolean _defaultState;
24-
final int _mask;
24+
private final boolean _defaultState;
25+
private final int _mask;
2526

2627
// Method that calculates bit set (flags) of all features that
2728
// are enabled by default.

‎yaml/src/main/java/tools/jackson/dataformat/yaml/YAMLFactory.java

+10-10
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ public class YAMLFactory
2929
* Bitfield (set of flags) of all generator features that are enabled
3030
* by default.
3131
*/
32-
protected final static int DEFAULT_YAML_PARSER_FEATURE_FLAGS = YAMLParser.Feature.collectDefaults();
32+
protected final static int DEFAULT_YAML_PARSER_FEATURE_FLAGS = YAMLReadFeature.collectDefaults();
3333

3434
/**
3535
* Bitfield (set of flags) of all generator features that are enabled
3636
* by default.
3737
*/
38-
protected final static int DEFAULT_YAML_GENERATOR_FEATURE_FLAGS = YAMLGenerator.Feature.collectDefaults();
38+
protected final static int DEFAULT_YAML_GENERATOR_FEATURE_FLAGS = YAMLWriteFeature.collectDefaults();
3939

4040
/*
4141
/**********************************************************************
@@ -64,9 +64,9 @@ public class YAMLFactory
6464
/**
6565
* Configuration for underlying generator to follow, if specified;
6666
* left as {@code null} for backwards compatibility (which means
67-
* the dumper options are derived based on {@link YAMLGenerator.Feature}s).
67+
* the dumper options are derived based on {@link YAMLWriteFeature}s).
6868
* <p>
69-
* These {@link YAMLGenerator.Feature}s are ignored if you provide your own DumperOptions:
69+
* These {@link YAMLWriteFeature}s are ignored if you provide your own DumperOptions:
7070
* <ul>
7171
* <li>{@code YAMLGenerator.Feature.ALLOW_LONG_KEYS}</li>
7272
* <li>{@code YAMLGenerator.Feature.CANONICAL_OUTPUT}</li>
@@ -204,13 +204,13 @@ public boolean canUseSchema(FormatSchema schema) {
204204
}
205205

206206
@Override
207-
public Class<YAMLParser.Feature> getFormatReadFeatureType() {
208-
return YAMLParser.Feature.class;
207+
public Class<YAMLReadFeature> getFormatReadFeatureType() {
208+
return YAMLReadFeature.class;
209209
}
210210

211211
@Override
212-
public Class<YAMLGenerator.Feature> getFormatWriteFeatureType() {
213-
return YAMLGenerator.Feature.class;
212+
public Class<YAMLWriteFeature> getFormatWriteFeatureType() {
213+
return YAMLWriteFeature.class;
214214
}
215215

216216
@Override
@@ -219,11 +219,11 @@ public Class<YAMLGenerator.Feature> getFormatWriteFeatureType() {
219219
@Override
220220
public int getFormatWriteFeatures() { return _formatWriteFeatures; }
221221

222-
public boolean isEnabled(YAMLParser.Feature f) {
222+
public boolean isEnabled(YAMLReadFeature f) {
223223
return (_formatReadFeatures & f.getMask()) != 0;
224224
}
225225

226-
public boolean isEnabled(YAMLGenerator.Feature f) {
226+
public boolean isEnabled(YAMLWriteFeature f) {
227227
return (_formatWriteFeatures & f.getMask()) != 0;
228228
}
229229

‎yaml/src/main/java/tools/jackson/dataformat/yaml/YAMLFactoryBuilder.java

+20-20
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ public class YAMLFactoryBuilder
5656
/**
5757
* Configuration for underlying generator to follow, if specified;
5858
* left as {@code null} for backwards compatibility (which means
59-
* the dumper options are derived based on {@link YAMLGenerator.Feature}s).
59+
* the dumper options are derived based on {@link YAMLWriteFeature}s).
6060
* <p>
61-
* These {@link YAMLGenerator.Feature}s are ignored if you provide your own DumperOptions:
61+
* These {@link YAMLWriteFeature}s are ignored if you provide your own DumperOptions:
6262
* <ul>
6363
* <li>{@code YAMLGenerator.Feature.ALLOW_LONG_KEYS}</li>
6464
* <li>{@code YAMLGenerator.Feature.CANONICAL_OUTPUT}</li>
@@ -97,33 +97,33 @@ public YAMLFactoryBuilder(YAMLFactory base) {
9797
/**********************************************************
9898
*/
9999

100-
public YAMLFactoryBuilder enable(YAMLGenerator.Feature f) {
100+
public YAMLFactoryBuilder enable(YAMLWriteFeature f) {
101101
_formatWriteFeatures |= f.getMask();
102102
return this;
103103
}
104104

105-
public YAMLFactoryBuilder enable(YAMLGenerator.Feature first, YAMLGenerator.Feature... other) {
105+
public YAMLFactoryBuilder enable(YAMLWriteFeature first, YAMLWriteFeature... other) {
106106
_formatWriteFeatures |= first.getMask();
107-
for (YAMLGenerator.Feature f : other) {
107+
for (YAMLWriteFeature f : other) {
108108
_formatWriteFeatures |= f.getMask();
109109
}
110110
return this;
111111
}
112112

113-
public YAMLFactoryBuilder disable(YAMLGenerator.Feature f) {
113+
public YAMLFactoryBuilder disable(YAMLWriteFeature f) {
114114
_formatWriteFeatures &= ~f.getMask();
115115
return this;
116116
}
117117

118-
public YAMLFactoryBuilder disable(YAMLGenerator.Feature first, YAMLGenerator.Feature... other) {
118+
public YAMLFactoryBuilder disable(YAMLWriteFeature first, YAMLWriteFeature... other) {
119119
_formatWriteFeatures &= ~first.getMask();
120-
for (YAMLGenerator.Feature f : other) {
120+
for (YAMLWriteFeature f : other) {
121121
_formatWriteFeatures &= ~f.getMask();
122122
}
123123
return this;
124124
}
125125

126-
public YAMLFactoryBuilder configure(YAMLGenerator.Feature f, boolean state) {
126+
public YAMLFactoryBuilder configure(YAMLWriteFeature f, boolean state) {
127127
return state ? enable(f) : disable(f);
128128
}
129129

@@ -133,33 +133,33 @@ public YAMLFactoryBuilder configure(YAMLGenerator.Feature f, boolean state) {
133133
/**********************************************************
134134
*/
135135

136-
public YAMLFactoryBuilder enable(YAMLParser.Feature f) {
136+
public YAMLFactoryBuilder enable(YAMLReadFeature f) {
137137
_formatReadFeatures |= f.getMask();
138138
return this;
139139
}
140140

141-
public YAMLFactoryBuilder enable(YAMLParser.Feature first, YAMLParser.Feature... other) {
141+
public YAMLFactoryBuilder enable(YAMLReadFeature first, YAMLReadFeature... other) {
142142
_formatReadFeatures |= first.getMask();
143-
for (YAMLParser.Feature f : other) {
143+
for (YAMLReadFeature f : other) {
144144
_formatReadFeatures |= f.getMask();
145145
}
146146
return this;
147147
}
148148

149-
public YAMLFactoryBuilder disable(YAMLParser.Feature f) {
149+
public YAMLFactoryBuilder disable(YAMLReadFeature f) {
150150
_formatReadFeatures &= ~f.getMask();
151151
return this;
152152
}
153153

154-
public YAMLFactoryBuilder disable(YAMLParser.Feature first, YAMLParser.Feature... other) {
154+
public YAMLFactoryBuilder disable(YAMLReadFeature first, YAMLReadFeature... other) {
155155
_formatReadFeatures &= ~first.getMask();
156-
for (YAMLParser.Feature f : other) {
156+
for (YAMLReadFeature f : other) {
157157
_formatReadFeatures &= ~f.getMask();
158158
}
159159
return this;
160160
}
161161

162-
public YAMLFactoryBuilder configure(YAMLParser.Feature f, boolean state) {
162+
public YAMLFactoryBuilder configure(YAMLReadFeature f, boolean state) {
163163
return state ? enable(f) : disable(f);
164164
}
165165

@@ -226,9 +226,9 @@ public YAMLFactoryBuilder loadSettings(LoadSettings settings) {
226226
/**
227227
* Configuration for underlying generator to follow, if specified;
228228
* left as {@code null} for backwards compatibility (which means
229-
* the dumper options are derived based on {@link YAMLGenerator.Feature}s).
229+
* the dumper options are derived based on {@link YAMLWriteFeature}s).
230230
* <p>
231-
* These {@link YAMLGenerator.Feature}s are ignored if you provide your own DumperOptions:
231+
* These {@link YAMLWriteFeature}s are ignored if you provide your own DumperOptions:
232232
* <ul>
233233
* <li>{@code YAMLGenerator.Feature.ALLOW_LONG_KEYS}</li>
234234
* <li>{@code YAMLGenerator.Feature.CANONICAL_OUTPUT}</li>
@@ -283,9 +283,9 @@ public LoadSettings loadSettings() {
283283
/**
284284
* Configuration for underlying generator to follow, if specified;
285285
* left as {@code null} for backwards compatibility (which means
286-
* the dumper options are derived based on {@link YAMLGenerator.Feature}s).
286+
* the dumper options are derived based on {@link YAMLWriteFeature}s).
287287
* <p>
288-
* These {@link YAMLGenerator.Feature}s are ignored if you provide your own DumperOptions:
288+
* These {@link YAMLWriteFeature}s are ignored if you provide your own DumperOptions:
289289
* <ul>
290290
* <li>{@code YAMLGenerator.Feature.ALLOW_LONG_KEYS}</li>
291291
* <li>{@code YAMLGenerator.Feature.CANONICAL_OUTPUT}</li>

0 commit comments

Comments
 (0)