Skip to content

Commit c55d157

Browse files
authored
Deprecate classes in package jsonschema (#3745)
1 parent 5c5e812 commit c55d157

32 files changed

+183
-31
lines changed

src/main/java/com/fasterxml/jackson/databind/ext/DOMSerializer.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ public void serialize(Node value, JsonGenerator g, SerializerProvider provider)
5151
}
5252
}
5353

54+
/**
55+
* @deprecated Since 2.15
56+
*/
57+
@Deprecated
5458
@Override
5559
public JsonNode getSchema(SerializerProvider provider, java.lang.reflect.Type typeHint) {
5660
// Well... it is serialized as String

src/main/java/com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,13 @@
1717
*
1818
* @author Ryan Heaton
1919
* @author Tatu Saloranta
20+
* @deprecated Since 2.15, we recommend use of external
21+
* <a href="https://github.com/FasterXML/jackson-module-jsonSchema">JSON Schema generator module</a>
2022
*/
2123
@Target(ElementType.TYPE)
2224
@Retention(RetentionPolicy.RUNTIME)
2325
@JacksonAnnotation
26+
@Deprecated
2427
public @interface JsonSerializableSchema
2528
{
2629
/**

src/main/java/com/fasterxml/jackson/databind/jsonschema/SchemaAware.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88

99
/**
1010
* Marker interface for schema-aware serializers.
11+
*
12+
* @deprecated Since 2.15, we recommend use of external
13+
* <a href="https://github.com/FasterXML/jackson-module-jsonSchema">JSON Schema generator module</a>
1114
*/
15+
@Deprecated
1216
public interface SchemaAware
1317
{
1418
/**

src/main/java/com/fasterxml/jackson/databind/ser/DefaultSerializerProvider.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
import com.fasterxml.jackson.databind.introspect.Annotated;
1212
import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
1313
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
14-
import com.fasterxml.jackson.databind.jsonschema.SchemaAware;
1514
import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
1615
import com.fasterxml.jackson.databind.node.ObjectNode;
1716
import com.fasterxml.jackson.databind.ser.impl.WritableObjectId;
@@ -583,8 +582,9 @@ public com.fasterxml.jackson.databind.jsonschema.JsonSchema generateJsonSchema(C
583582
* type information it needs is accessible via "untyped" serializer)
584583
*/
585584
JsonSerializer<Object> ser = findValueSerializer(type, null);
586-
JsonNode schemaNode = (ser instanceof SchemaAware) ?
587-
((SchemaAware) ser).getSchema(this, null) : com.fasterxml.jackson.databind.jsonschema.JsonSchema.getDefaultSchemaNode();
585+
JsonNode schemaNode = (ser instanceof com.fasterxml.jackson.databind.jsonschema.SchemaAware)
586+
? ((com.fasterxml.jackson.databind.jsonschema.SchemaAware) ser).getSchema(this, null)
587+
: com.fasterxml.jackson.databind.jsonschema.JsonSchema.getDefaultSchemaNode();
588588
if (!(schemaNode instanceof ObjectNode)) {
589589
throw new IllegalArgumentException("Class " + type.getName()
590590
+" would not be serialized as a JSON object and therefore has no schema");

src/main/java/com/fasterxml/jackson/databind/ser/impl/StringArraySerializer.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,10 @@ private void serializeContentsSlow(String[] value, JsonGenerator gen, Serializer
210210
}
211211
}
212212

213+
/**
214+
* @deprecated Since 2.15
215+
*/
216+
@Deprecated
213217
@Override
214218
public JsonNode getSchema(SerializerProvider provider, Type typeHint) {
215219
return createSchemaNode("array", true).set("items", createSchemaNode("string"));

src/main/java/com/fasterxml/jackson/databind/ser/std/AsArraySerializerBase.java

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
import com.fasterxml.jackson.databind.*;
1313
import com.fasterxml.jackson.databind.introspect.AnnotatedMember;
1414
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
15-
import com.fasterxml.jackson.databind.jsonschema.SchemaAware;
1615
import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
1716
import com.fasterxml.jackson.databind.node.ObjectNode;
1817
import com.fasterxml.jackson.databind.ser.ContainerSerializer;
@@ -271,16 +270,20 @@ public void serializeWithType(T value, JsonGenerator g, SerializerProvider provi
271270
protected abstract void serializeContents(T value, JsonGenerator gen, SerializerProvider provider)
272271
throws IOException;
273272

274-
@SuppressWarnings("deprecation")
273+
/**
274+
* @deprecated Since 2.15
275+
*/
276+
@Deprecated
275277
@Override
276278
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
277279
throws JsonMappingException
278280
{
279281
ObjectNode o = createSchemaNode("array", true);
280282
if (_elementSerializer != null) {
281283
JsonNode schemaNode = null;
282-
if (_elementSerializer instanceof SchemaAware) {
283-
schemaNode = ((SchemaAware) _elementSerializer).getSchema(provider, null);
284+
if (_elementSerializer instanceof com.fasterxml.jackson.databind.jsonschema.SchemaAware) {
285+
schemaNode = ((com.fasterxml.jackson.databind.jsonschema.SchemaAware) _elementSerializer)
286+
.getSchema(provider, null);
284287
}
285288
if (schemaNode == null) {
286289
schemaNode = com.fasterxml.jackson.databind.jsonschema.JsonSchema.getDefaultSchemaNode();

src/main/java/com/fasterxml/jackson/databind/ser/std/BeanSerializerBase.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable;
1616
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
1717
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor;
18-
import com.fasterxml.jackson.databind.jsonschema.JsonSerializableSchema;
19-
import com.fasterxml.jackson.databind.jsonschema.SchemaAware;
2018
import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
2119
import com.fasterxml.jackson.databind.node.ObjectNode;
2220
import com.fasterxml.jackson.databind.ser.*;
@@ -40,7 +38,7 @@
4038
public abstract class BeanSerializerBase
4139
extends StdSerializer<Object>
4240
implements ContextualSerializer, ResolvableSerializer,
43-
JsonFormatVisitable, SchemaAware
41+
JsonFormatVisitable
4442
{
4543
protected final static PropertyName NAME_FOR_OBJECT_REF = new PropertyName("#object-ref");
4644

@@ -849,7 +847,8 @@ public JsonNode getSchema(SerializerProvider provider, Type typeHint)
849847
ObjectNode o = createSchemaNode("object", true);
850848
// [JACKSON-813]: Add optional JSON Schema id attribute, if found
851849
// NOTE: not optimal, does NOT go through AnnotationIntrospector etc:
852-
JsonSerializableSchema ann = _handledType.getAnnotation(JsonSerializableSchema.class);
850+
com.fasterxml.jackson.databind.jsonschema.JsonSerializableSchema ann =
851+
_handledType.getAnnotation(com.fasterxml.jackson.databind.jsonschema.JsonSerializableSchema.class);
853852
if (ann != null) {
854853
String id = ann.id();
855854
if (id != null && !id.isEmpty()) {

src/main/java/com/fasterxml/jackson/databind/ser/std/BooleanSerializer.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ public final void serializeWithType(Object value, JsonGenerator g, SerializerPro
7575
g.writeBoolean(Boolean.TRUE.equals(value));
7676
}
7777

78+
/**
79+
* @deprecated Since 2.15
80+
*/
81+
@Deprecated
7882
@Override
7983
public JsonNode getSchema(SerializerProvider provider, Type typeHint) {
8084
return createSchemaNode("boolean", !_forPrimitive);

src/main/java/com/fasterxml/jackson/databind/ser/std/ByteArraySerializer.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ public void serializeWithType(byte[] value, JsonGenerator g, SerializerProvider
6969
*/
7070
}
7171

72+
/**
73+
* @deprecated Since 2.15
74+
*/
75+
@Deprecated
7276
@Override
7377
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
7478
{

src/main/java/com/fasterxml/jackson/databind/ser/std/ClassSerializer.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ public void serialize(Class<?> value, JsonGenerator g, SerializerProvider provid
2727
g.writeString(value.getName());
2828
}
2929

30+
/**
31+
* @deprecated Since 2.15
32+
*/
33+
@Deprecated
3034
@Override
3135
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
3236
{

0 commit comments

Comments
 (0)