Skip to content

Commit 5d27867

Browse files
authored
Implement #528: Smile read/write features (#529)
1 parent 57155b9 commit 5d27867

30 files changed

+314
-302
lines changed

release-notes/VERSION

+2
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,5 @@ implementations)
2525
#524: JSTEP-8: rename `CBORGenerator.Feature` as `CBORWriteFeature`
2626
#526: JSTEP-8: rename `IonParser.Feature` as `IonReadFeature`,
2727
`IonGenerator.Feature` as `IonWriteFeature`
28+
#528: JSTEP-8: rename `SmileParser.Feature` as `SmileReadFeature`,
29+
`SmileGenerator.Feature` as `SmileWriteFeature`

smile/src/main/java/tools/jackson/dataformat/smile/SmileFactory.java

+11-11
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ public class SmileFactory
5050
* Bitfield (set of flags) of all parser features that are enabled
5151
* by default.
5252
*/
53-
final static int DEFAULT_SMILE_PARSER_FEATURE_FLAGS = SmileParser.Feature.collectDefaults();
53+
final static int DEFAULT_SMILE_PARSER_FEATURE_FLAGS = SmileReadFeature.collectDefaults();
5454

5555
/**
5656
* Bitfield (set of flags) of all generator features that are enabled
5757
* by default.
5858
*/
59-
final static int DEFAULT_SMILE_GENERATOR_FEATURE_FLAGS = SmileGenerator.Feature.collectDefaults();
59+
final static int DEFAULT_SMILE_GENERATOR_FEATURE_FLAGS = SmileWriteFeature.collectDefaults();
6060

6161
/*
6262
/**********************************************************************
@@ -163,14 +163,14 @@ public Version version() {
163163
/**
164164
* Checked whether specified parser feature is enabled.
165165
*/
166-
public final boolean isEnabled(SmileParser.Feature f) {
166+
public final boolean isEnabled(SmileReadFeature f) {
167167
return f.enabledIn(_formatReadFeatures);
168168
}
169169

170170
/**
171171
* Check whether specified generator feature is enabled.
172172
*/
173-
public final boolean isEnabled(SmileGenerator.Feature f) {
173+
public final boolean isEnabled(SmileWriteFeature f) {
174174
return f.enabledIn(_formatWriteFeatures);
175175
}
176176

@@ -191,13 +191,13 @@ public boolean canUseSchema(FormatSchema schema) {
191191
}
192192

193193
@Override
194-
public Class<SmileParser.Feature> getFormatReadFeatureType() {
195-
return SmileParser.Feature.class;
194+
public Class<SmileReadFeature> getFormatReadFeatureType() {
195+
return SmileReadFeature.class;
196196
}
197197

198198
@Override
199-
public Class<SmileGenerator.Feature> getFormatWriteFeatureType() {
200-
return SmileGenerator.Feature.class;
199+
public Class<SmileWriteFeature> getFormatWriteFeatureType() {
200+
return SmileWriteFeature.class;
201201
}
202202

203203
/*
@@ -274,15 +274,15 @@ protected JsonGenerator _createGenerator(ObjectWriteContext writeCtxt,
274274
SmileGenerator gen = new SmileGenerator(writeCtxt, ioCtxt,
275275
writeCtxt.getStreamWriteFeatures(_streamWriteFeatures),
276276
smileFeatures, out);
277-
if (SmileGenerator.Feature.WRITE_HEADER.enabledIn(smileFeatures)) {
277+
if (SmileWriteFeature.WRITE_HEADER.enabledIn(smileFeatures)) {
278278
gen.writeHeader();
279279
} else {
280-
if (SmileGenerator.Feature.CHECK_SHARED_STRING_VALUES.enabledIn(smileFeatures)) {
280+
if (SmileWriteFeature.CHECK_SHARED_STRING_VALUES.enabledIn(smileFeatures)) {
281281
throw new StreamWriteException(gen,
282282
"Inconsistent settings: WRITE_HEADER disabled, but CHECK_SHARED_STRING_VALUES enabled; can not construct generator"
283283
+" due to possible data loss (either enable WRITE_HEADER, or disable CHECK_SHARED_STRING_VALUES to resolve)");
284284
}
285-
if (!SmileGenerator.Feature.ENCODE_BINARY_AS_7BIT.enabledIn(smileFeatures)) {
285+
if (!SmileWriteFeature.ENCODE_BINARY_AS_7BIT.enabledIn(smileFeatures)) {
286286
throw new StreamWriteException(gen,
287287
"Inconsistent settings: WRITE_HEADER disabled, but ENCODE_BINARY_AS_7BIT disabled; can not construct generator"
288288
+" due to possible data loss (either enable WRITE_HEADER, or ENCODE_BINARY_AS_7BIT to resolve)");

smile/src/main/java/tools/jackson/dataformat/smile/SmileFactoryBuilder.java

+14-14
Original file line numberDiff line numberDiff line change
@@ -43,65 +43,65 @@ public SmileFactory build() {
4343

4444
// // // Parser features
4545

46-
public SmileFactoryBuilder enable(SmileParser.Feature f) {
46+
public SmileFactoryBuilder enable(SmileReadFeature f) {
4747
_formatReadFeatures |= f.getMask();
4848
return _this();
4949
}
5050

51-
public SmileFactoryBuilder enable(SmileParser.Feature first, SmileParser.Feature... other) {
51+
public SmileFactoryBuilder enable(SmileReadFeature first, SmileReadFeature... other) {
5252
_formatReadFeatures |= first.getMask();
53-
for (SmileParser.Feature f : other) {
53+
for (SmileReadFeature f : other) {
5454
_formatReadFeatures |= f.getMask();
5555
}
5656
return _this();
5757
}
5858

59-
public SmileFactoryBuilder disable(SmileParser.Feature f) {
59+
public SmileFactoryBuilder disable(SmileReadFeature f) {
6060
_formatReadFeatures &= ~f.getMask();
6161
return _this();
6262
}
6363

64-
public SmileFactoryBuilder disable(SmileParser.Feature first, SmileParser.Feature... other) {
64+
public SmileFactoryBuilder disable(SmileReadFeature first, SmileReadFeature... other) {
6565
_formatReadFeatures &= ~first.getMask();
66-
for (SmileParser.Feature f : other) {
66+
for (SmileReadFeature f : other) {
6767
_formatReadFeatures &= ~f.getMask();
6868
}
6969
return _this();
7070
}
7171

72-
public SmileFactoryBuilder configure(SmileParser.Feature f, boolean state) {
72+
public SmileFactoryBuilder configure(SmileReadFeature f, boolean state) {
7373
return state ? enable(f) : disable(f);
7474
}
7575

7676
// // // Generator features
7777

78-
public SmileFactoryBuilder enable(SmileGenerator.Feature f) {
78+
public SmileFactoryBuilder enable(SmileWriteFeature f) {
7979
_formatWriteFeatures |= f.getMask();
8080
return _this();
8181
}
8282

83-
public SmileFactoryBuilder enable(SmileGenerator.Feature first, SmileGenerator.Feature... other) {
83+
public SmileFactoryBuilder enable(SmileWriteFeature first, SmileWriteFeature... other) {
8484
_formatWriteFeatures |= first.getMask();
85-
for (SmileGenerator.Feature f : other) {
85+
for (SmileWriteFeature f : other) {
8686
_formatWriteFeatures |= f.getMask();
8787
}
8888
return _this();
8989
}
9090

91-
public SmileFactoryBuilder disable(SmileGenerator.Feature f) {
91+
public SmileFactoryBuilder disable(SmileWriteFeature f) {
9292
_formatWriteFeatures &= ~f.getMask();
9393
return _this();
9494
}
9595

96-
public SmileFactoryBuilder disable(SmileGenerator.Feature first, SmileGenerator.Feature... other) {
96+
public SmileFactoryBuilder disable(SmileWriteFeature first, SmileWriteFeature... other) {
9797
_formatWriteFeatures &= ~first.getMask();
98-
for (SmileGenerator.Feature f : other) {
98+
for (SmileWriteFeature f : other) {
9999
_formatWriteFeatures &= ~f.getMask();
100100
}
101101
return _this();
102102
}
103103

104-
public SmileFactoryBuilder configure(SmileGenerator.Feature f, boolean state) {
104+
public SmileFactoryBuilder configure(SmileWriteFeature f, boolean state) {
105105
return state ? enable(f) : disable(f);
106106
}
107107
}

0 commit comments

Comments
 (0)