Skip to content

Commit

Permalink
Fix #3043: rename SerializerProvider as SerializationContext
Browse files Browse the repository at this point in the history
  • Loading branch information
@cowtowncoder
cowtowncoder committed Nov 29, 2024
1 parent bba5cbc commit 73d57a8
Show file tree
Hide file tree
Showing 193 changed files with 710 additions and 709 deletions.
1 change: 1 addition & 0 deletions release-notes/VERSION
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Versions: 3.x (for earlier see VERSION-2.x)
#3028: Change `UUIDSerializer` to use `StreamWriteCapability` check instead of
`JsonGenerator.canWriteBinaryNatively()`
#3037: Rename `Module` as `JacksonModule` in 3.0 (to avoid overlap with `java.lang.Module`)
#3043: Rename `SerializerProvider` as `SerializationContext`
#3044: Rename `JsonDeserializer`/`JsonSerializer` as `ValueDeserializer`/`ValueSerializer`
#3046: Rename `JsonSerializable` as `JacksonSerializable`
#3047: Rename `Bean[De]SerializerModifier` as `Value[De]SerializerModifier`
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/tools/jackson/databind/BeanProperty.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public interface BeanProperty extends FullyNamed
* @param objectVisitor Visitor to used as the callback handler
*/
public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor,
SerializerProvider provider);
SerializationContext provider);

/*
/**********************************************************************
Expand Down Expand Up @@ -279,7 +279,7 @@ public List<PropertyName> findAliases(MapperConfig<?> config) {
*/
@Override
public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor,
SerializerProvider provider) {
SerializationContext provider) {
throw new UnsupportedOperationException("Instances of "+getClass().getName()+" should not get visited");
}
}
Expand Down Expand Up @@ -364,7 +364,7 @@ public List<PropertyName> findAliases(MapperConfig<?> config) {

@Override
public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor,
SerializerProvider provider) {
SerializationContext provider) {
}
}
}
2 changes: 1 addition & 1 deletion src/main/java/tools/jackson/databind/DatabindContext.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

/**
* Shared base class for {@link DeserializationContext} and
* {@link SerializerProvider}, context objects passed through data-binding
* {@link SerializationContext}, context objects passed through data-binding
* process. Designed so that some of implementations can rely on shared
* aspects like access to secondary contextual objects like type factories
* or handler instantiators.
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/tools/jackson/databind/DatabindException.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,17 @@ private static JsonParser _parser(DeserializationContext ctxt) {
return (ctxt == null) ? null : ctxt.getParser();
}

public static DatabindException from(SerializerProvider ctxt, String msg) {
public static DatabindException from(SerializationContext ctxt, String msg) {
return new DatabindException(_generator(ctxt), msg);
}

public static DatabindException from(SerializerProvider ctxt, String msg, Throwable problem) {
public static DatabindException from(SerializationContext ctxt, String msg, Throwable problem) {
// 17-Aug-2015, tatu: As per [databind#903] this is bit problematic as
// SerializerProvider instance does not currently hold on to generator...
// SerializationContext instance does not currently hold on to generator...
return new DatabindException(_generator(ctxt), msg, problem);
}

private static JsonGenerator _generator(SerializerProvider ctxt) {
private static JsonGenerator _generator(SerializationContext ctxt) {
return (ctxt == null) ? null : ctxt.getGenerator();
}
}
8 changes: 4 additions & 4 deletions src/main/java/tools/jackson/databind/JacksonSerializable.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
/**
* Interface that can be implemented by objects that know how to
* serialize themselves to JSON, using {@link JsonGenerator}
* (and {@link SerializerProvider} if necessary).
* (and {@link SerializationContext} if necessary).
*<p>
* Note that implementing this interface binds implementing object
* closely to Jackson API, and that it is often not necessary to do
Expand All @@ -25,7 +25,7 @@ public interface JacksonSerializable
* Serialization method called when no additional type information is
* to be included in serialization.
*/
public void serialize(JsonGenerator gen, SerializerProvider serializers)
public void serialize(JsonGenerator gen, SerializationContext serializers)
throws JacksonException;

/**
Expand All @@ -41,7 +41,7 @@ public void serialize(JsonGenerator gen, SerializerProvider serializers)
* Note that some types (most notably, "natural" types: String, Integer,
* Double and Boolean) never include type information.
*/
public void serializeWithType(JsonGenerator gen, SerializerProvider serializers,
public void serializeWithType(JsonGenerator gen, SerializationContext serializers,
TypeSerializer typeSer)
throws JacksonException;

Expand All @@ -57,7 +57,7 @@ public abstract static class Base implements JacksonSerializable
* Method that may be called on instance to determine if it is considered
* "empty" for purposes of serialization filtering or not.
*/
public boolean isEmpty(SerializerProvider serializers) {
public boolean isEmpty(SerializationContext serializers) {
return false;
}
}
Expand Down
50 changes: 25 additions & 25 deletions src/main/java/tools/jackson/databind/ObjectMapper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,9 @@ protected Object readResolve() {
*/

/**
* Factory used for constructing per-call {@link SerializerProvider}s.
* Factory used for constructing per-call {@link SerializationContext}s.
*<p>
* Note: while serializers are only exposed {@link SerializerProvider},
* Note: while serializers are only exposed {@link SerializationContext},
* mappers and readers need to access additional API defined by
* {@link SerializationContextExt}
*/
Expand Down Expand Up @@ -754,7 +754,7 @@ public JsonParser createNonBlockingByteArrayParser() throws JacksonException {
*/
public JsonGenerator createGenerator(OutputStream out) throws JacksonException {
_assertNotNull("out", out);
return _streamFactory.createGenerator(_serializerProvider(), out);
return _streamFactory.createGenerator(_serializationContext(), out);
}

/**
Expand All @@ -767,7 +767,7 @@ public JsonGenerator createGenerator(OutputStream out) throws JacksonException {
*/
public JsonGenerator createGenerator(OutputStream out, JsonEncoding enc) throws JacksonException {
_assertNotNull("out", out);
return _streamFactory.createGenerator(_serializerProvider(), out, enc);
return _streamFactory.createGenerator(_serializationContext(), out, enc);
}

/**
Expand All @@ -780,7 +780,7 @@ public JsonGenerator createGenerator(OutputStream out, JsonEncoding enc) throws
*/
public JsonGenerator createGenerator(Writer w) throws JacksonException {
_assertNotNull("w", w);
return _streamFactory.createGenerator(_serializerProvider(), w);
return _streamFactory.createGenerator(_serializationContext(), w);
}

/**
Expand All @@ -793,7 +793,7 @@ public JsonGenerator createGenerator(Writer w) throws JacksonException {
*/
public JsonGenerator createGenerator(File f, JsonEncoding enc) throws JacksonException {
_assertNotNull("f", f);
return _streamFactory.createGenerator(_serializerProvider(), f, enc);
return _streamFactory.createGenerator(_serializationContext(), f, enc);
}

/**
Expand All @@ -806,7 +806,7 @@ public JsonGenerator createGenerator(File f, JsonEncoding enc) throws JacksonExc
*/
public JsonGenerator createGenerator(Path path, JsonEncoding enc) throws JacksonException {
_assertNotNull("path", path);
return _streamFactory.createGenerator(_serializerProvider(), path, enc);
return _streamFactory.createGenerator(_serializationContext(), path, enc);
}

/**
Expand All @@ -819,7 +819,7 @@ public JsonGenerator createGenerator(Path path, JsonEncoding enc) throws Jackson
*/
public JsonGenerator createGenerator(DataOutput out) throws JacksonException {
_assertNotNull("out", out);
return _streamFactory.createGenerator(_serializerProvider(), out);
return _streamFactory.createGenerator(_serializationContext(), out);
}

/*
Expand Down Expand Up @@ -934,7 +934,7 @@ public void writeTree(JsonGenerator g, TreeNode rootNode) throws JacksonExceptio
{
_assertNotNull("g", g);
SerializationConfig config = serializationConfig();
_serializerProvider(config).serializeValue(g, rootNode);
_serializationContext(config).serializeValue(g, rootNode);
if (config.isEnabled(SerializationFeature.FLUSH_AFTER_WRITE_VALUE)) {
g.flush();
}
Expand Down Expand Up @@ -1235,7 +1235,7 @@ public void writeValue(JsonGenerator g, Object value) throws JacksonException
if (config.isEnabled(SerializationFeature.CLOSE_CLOSEABLE) && (value instanceof Closeable)) {
_writeCloseableValue(g, value, config);
} else {
_serializerProvider(config).serializeValue(g, value);
_serializationContext(config).serializeValue(g, value);
if (config.isEnabled(SerializationFeature.FLUSH_AFTER_WRITE_VALUE)) {
g.flush();
}
Expand Down Expand Up @@ -1358,7 +1358,7 @@ public <T extends JsonNode> T valueToTree(Object fromValue)
{
// 02-Mar-2021, tatu: [databind#2411] Rewrite "valueToTree()" impl; old
// impl left for reference
return _serializerProvider().valueToTree(fromValue);
return _serializationContext().valueToTree(fromValue);
}

/*
Expand Down Expand Up @@ -1764,7 +1764,7 @@ public <T> T readValue(DataInput src, TypeReference<T> valueTypeRef) throws Jack
public void writeValue(File file, Object value) throws JacksonException
{
_assertNotNull("file", file);
SerializationContextExt prov = _serializerProvider();
SerializationContextExt prov = _serializationContext();
_configAndWriteValue(prov,
_streamFactory.createGenerator(prov, file, JsonEncoding.UTF8), value);
}
Expand All @@ -1778,7 +1778,7 @@ public void writeValue(File file, Object value) throws JacksonException
public void writeValue(Path path, Object value) throws JacksonException
{
_assertNotNull("path", path);
SerializationContextExt prov = _serializerProvider();
SerializationContextExt prov = _serializationContext();
_configAndWriteValue(prov,
_streamFactory.createGenerator(prov, path, JsonEncoding.UTF8), value);
}
Expand All @@ -1797,15 +1797,15 @@ public void writeValue(Path path, Object value) throws JacksonException
public void writeValue(OutputStream out, Object value) throws JacksonException
{
_assertNotNull("out", out);
SerializationContextExt prov = _serializerProvider();
SerializationContextExt prov = _serializationContext();
_configAndWriteValue(prov,
_streamFactory.createGenerator(prov, out, JsonEncoding.UTF8), value);
}

public void writeValue(DataOutput out, Object value) throws JacksonException
{
_assertNotNull("out", out);
SerializationContextExt prov = _serializerProvider();
SerializationContextExt prov = _serializationContext();
_configAndWriteValue(prov,
_streamFactory.createGenerator(prov, out), value);
}
Expand All @@ -1823,7 +1823,7 @@ public void writeValue(DataOutput out, Object value) throws JacksonException
public void writeValue(Writer w, Object value) throws JacksonException
{
_assertNotNull("w", w);
SerializationContextExt prov = _serializerProvider();
SerializationContextExt prov = _serializationContext();
_configAndWriteValue(prov, _streamFactory.createGenerator(prov, w), value);
}

Expand All @@ -1839,7 +1839,7 @@ public String writeValueAsString(Object value) throws JacksonException
final BufferRecycler br = _streamFactory._getBufferRecycler();
// alas, we have to pull the recycler directly here...
try (SegmentedStringWriter sw = new SegmentedStringWriter(br)) {
SerializationContextExt prov = _serializerProvider();
SerializationContextExt prov = _serializationContext();
_configAndWriteValue(prov, _streamFactory.createGenerator(prov, sw), value);
return sw.getAndClear();
} finally {
Expand All @@ -1859,7 +1859,7 @@ public byte[] writeValueAsBytes(Object value) throws JacksonException
{
final BufferRecycler br = _streamFactory._getBufferRecycler();
try (ByteArrayBuilder bb = new ByteArrayBuilder(br)) {
final SerializationContextExt ctxt = _serializerProvider();
final SerializationContextExt ctxt = _serializationContext();
_configAndWriteValue(ctxt,
_streamFactory.createGenerator(ctxt, bb, JsonEncoding.UTF8), value);
return bb.getClearAndRelease();
Expand Down Expand Up @@ -1919,7 +1919,7 @@ protected final void _writeCloseableValue(JsonGenerator g, Object value, Seriali
{
Closeable toClose = (Closeable) value;
try {
_serializerProvider(cfg).serializeValue(g, value);
_serializationContext(cfg).serializeValue(g, value);
if (cfg.isEnabled(SerializationFeature.FLUSH_AFTER_WRITE_VALUE)) {
g.flush();
}
Expand Down Expand Up @@ -2361,7 +2361,7 @@ protected Object _convert(Object fromValue, JavaType toValueType)
// first: disable wrapping when writing
final SerializationConfig config = serializationConfig()
.without(SerializationFeature.WRAP_ROOT_VALUE);
final SerializationContextExt ctxt = _serializerProvider(config);
final SerializationContextExt ctxt = _serializationContext(config);
TokenBuffer buf = ctxt.bufferForValueConversion();
// Would like to let buffer decide, but it won't have deser config to check so...
if (isEnabled(DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS)) {
Expand Down Expand Up @@ -2431,7 +2431,7 @@ public <T> T updateValue(T valueToUpdate, Object overrides)
}
SerializationConfig config = serializationConfig()
.without(SerializationFeature.WRAP_ROOT_VALUE);
SerializationContextExt ctxt = _serializerProvider(config);
SerializationContextExt ctxt = _serializationContext(config);
TokenBuffer buf = ctxt.bufferForValueConversion();
// Would like to let buffer decide, but it won't have deser config to check so...
if (isEnabled(DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS)) {
Expand Down Expand Up @@ -2487,7 +2487,7 @@ public void acceptJsonFormatVisitor(JavaType type, JsonFormatVisitorWrapper visi
{
_assertNotNull("type", type);
_assertNotNull("visitor", visitor);
_serializerProvider().acceptJsonFormatVisitor(type, visitor);
_serializationContext().acceptJsonFormatVisitor(type, visitor);
}

/*
Expand All @@ -2498,16 +2498,16 @@ public void acceptJsonFormatVisitor(JavaType type, JsonFormatVisitorWrapper visi

/**
* Overridable helper method used for constructing
* {@link SerializerProvider} to use for serialization.
* {@link SerializationContext} to use for serialization.
*/
protected SerializationContextExt _serializerProvider(SerializationConfig config) {
protected SerializationContextExt _serializationContext(SerializationConfig config) {
// 03-Oct-2017, tatu: Should be ok to pass "empty" generator settings...
return _serializationContexts.createContext(config,
GeneratorSettings.empty());
}

// NOTE: only public to allow for testing
public SerializationContextExt _serializerProvider() {
public SerializationContextExt _serializationContext() {
// 03-Oct-2017, tatu: Should be ok to pass "empty" generator settings...
return _serializationContexts.createContext(serializationConfig(),
GeneratorSettings.empty());
Expand Down
Loading

0 comments on commit 73d57a8

Please sign in to comment.