Use enums for union variant tags

Author: swallez

java-client/src/main/java/co/elastic/clients/json/AttributedJsonpMapper.java

@@ -29,7 +29,7 @@ class AttributedJsonpMapper implements JsonpMapper {
  private final String name;
  private final Object value;
 
- public AttributedJsonpMapper(JsonpMapper mapper, String name, Object value) {
+ AttributedJsonpMapper(JsonpMapper mapper, String name, Object value) {
  this.mapper = mapper;
  this.name = name;
  this.value = value;

java-client/src/main/java/co/elastic/clients/json/ExternallyTaggedUnion.java

@@ -45,7 +45,7 @@ public interface ExternallyTaggedUnion {
  * A deserializer for externally-tagged unions. Since the union variant discriminant is provided externally, this cannot be a
  * regular {@link JsonpDeserializer} as the caller has to provide the discriminant value.
  */
- class Deserializer<Union extends TaggedUnion<Member>, Member> {
+ class Deserializer<Union extends TaggedUnion<?, Member>, Member> {
  private final Map<String, JsonpDeserializer<? extends Member>> deserializers;
  private final BiFunction<String, Member, Union> unionCtor;
 
@@ -75,7 +75,7 @@ public TypedKeysDeserializer<Union> typedKeys() {
  }
  }
 
- class TypedKeysDeserializer<Union extends TaggedUnion<?>> extends JsonpDeserializerBase<Map<String, Union>> {
+ class TypedKeysDeserializer<Union extends TaggedUnion<?, ?>> extends JsonpDeserializerBase<Map<String, Union>> {
  Deserializer<Union, ?> deserializer;
  protected TypedKeysDeserializer(Deserializer<Union, ?> deser) {
  super(EnumSet.of(Event.START_OBJECT));
@@ -111,20 +111,20 @@ public void deserializeEntry(String key, JsonParser parser, JsonpMapper mapper,
  /**
  * Serialize an externally tagged union using the typed keys encoding.
  */
- static <T extends JsonpSerializable & TaggedUnion<?>> void serializeTypedKeys(
+ static <T extends JsonpSerializable & TaggedUnion<? extends JsonEnum, ?>> void serializeTypedKeys(
  Map<String, T> map, JsonGenerator generator, JsonpMapper mapper
  ) {
  generator.writeStartObject();
  serializeTypedKeysInner(map, generator, mapper);
  generator.writeEnd();
  }
 
- static <T extends JsonpSerializable & TaggedUnion<?>> void serializeTypedKeysInner(
+ static <T extends JsonpSerializable & TaggedUnion<? extends JsonEnum, ?>> void serializeTypedKeysInner(
  Map<String, T> map, JsonGenerator generator, JsonpMapper mapper
  ) {
  for (Map.Entry<String, T> entry: map.entrySet()) {
  T value = entry.getValue();
- generator.writeKey(value._type() + "#" + entry.getKey());
+ generator.writeKey(value._kind().jsonValue() + "#" + entry.getKey());
  value.serialize(generator, mapper);
  }
  }

java-client/src/main/java/co/elastic/clients/util/StringEnum.java renamed to java-client/src/main/java/co/elastic/clients/json/JsonEnum.java

@@ -17,11 +17,8 @@
  * under the License.
  */
 
-package co.elastic.clients.util;
+package co.elastic.clients.json;
 
-import co.elastic.clients.json.JsonpDeserializerBase;
-import co.elastic.clients.json.JsonpMapper;
-import co.elastic.clients.json.JsonpSerializable;
 import jakarta.json.stream.JsonGenerator;
 import jakarta.json.stream.JsonParser;
 import jakarta.json.stream.JsonParsingException;
@@ -34,15 +31,15 @@
 /**
  * Base interface for enumerations.
  */
-public interface StringEnum extends JsonpSerializable {
+public interface JsonEnum extends JsonpSerializable {
  String jsonValue();
 
  @Override
  default void serialize(JsonGenerator generator, JsonpMapper params) {
  generator.write(jsonValue());
  }
 
- class Deserializer<T extends Enum<T> & StringEnum> extends JsonpDeserializerBase<T> {
+ class Deserializer<T extends JsonEnum> extends JsonpDeserializerBase<T> {
  private final Map<String, T> lookupTable;
 
  public Deserializer(T[] values) {

java-client/src/main/java/co/elastic/clients/json/JsonpDeserializer.java

@@ -19,7 +19,6 @@
 
 package co.elastic.clients.json;
 
-import co.elastic.clients.util.StringEnum;
 import jakarta.json.JsonValue;
 import jakarta.json.stream.JsonParser;
 import jakarta.json.stream.JsonParser.Event;
@@ -187,7 +186,7 @@ static <T> JsonpDeserializer<Map<String, T>> stringMapDeserializer(JsonpDeserial
  return new JsonpDeserializerBase.StringMapDeserializer<T>(itemDeserializer);
  }
 
- static <K extends StringEnum, V> JsonpDeserializer<Map<K, V>> enumMapDeserializer(
+ static <K extends JsonEnum, V> JsonpDeserializer<Map<K, V>> enumMapDeserializer(
  JsonpDeserializer<K> keyDeserializer, JsonpDeserializer<V> valueDeserializer
  ) {
  return new JsonpDeserializerBase.EnumMapDeserializer<K, V>(keyDeserializer, valueDeserializer);

java-client/src/main/java/co/elastic/clients/json/UnionDeserializer.java

@@ -36,30 +36,30 @@
 import java.util.Set;
 import java.util.function.BiFunction;
 
-public class UnionDeserializer<T, M> implements JsonpDeserializer<T> {
+public class UnionDeserializer<Union, Kind, Member> implements JsonpDeserializer<Union> {
 
  public static class AmbiguousUnionException extends RuntimeException {
  public AmbiguousUnionException(String message) {
  super(message);
  }
  }
 
- private abstract static class EventHandler<T, M> {
- abstract T deserialize(JsonParser parser, JsonpMapper mapper, Event event, BiFunction<String, M, T> buildFn);
+ private abstract static class EventHandler<Union, Kind, Member> {
+ abstract Union deserialize(JsonParser parser, JsonpMapper mapper, Event event, BiFunction<Kind, Member, Union> buildFn);
  abstract EnumSet<Event> nativeEvents();
  }
 
- private static class SingleMemberHandler<T, M> extends EventHandler<T, M> {
- private final JsonpDeserializer<? extends M> deserializer;
- private final String tag;
+ private static class SingleMemberHandler<Union, Kind, Member> extends EventHandler<Union, Kind, Member> {
+ private final JsonpDeserializer<? extends Member> deserializer;
+ private final Kind tag;
  // ObjectDeserializers provide the list of fields they know about
  private final Set<String> fields;
 
- SingleMemberHandler(String tag, JsonpDeserializer<? extends M> deserializer) {
+ SingleMemberHandler(Kind tag, JsonpDeserializer<? extends Member> deserializer) {
  this(tag, deserializer, null);
  }
 
- SingleMemberHandler(String tag, JsonpDeserializer<? extends M> deserializer, Set<String> fields) {
+ SingleMemberHandler(Kind tag, JsonpDeserializer<? extends Member> deserializer, Set<String> fields) {
  this.deserializer = deserializer;
  this.tag = tag;
  this.fields = fields;
@@ -71,7 +71,7 @@ EnumSet<Event> nativeEvents() {
  }
 
  @Override
- T deserialize(JsonParser parser, JsonpMapper mapper, Event event, BiFunction<String, M, T> buildFn) {
+ Union deserialize(JsonParser parser, JsonpMapper mapper, Event event, BiFunction<Kind, Member, Union> buildFn) {
  return buildFn.apply(tag, deserializer.deserialize(parser, mapper, event));
  }
  }
@@ -80,22 +80,22 @@ T deserialize(JsonParser parser, JsonpMapper mapper, Event event, BiFunction<Str
  * An event handler for value events (string, number, etc) that can try multiple handlers, which are ordered
  * from most specific (e.g. enum) to least specific (e.g. string)
  */
- private static class MultiMemberHandler<T, M> extends EventHandler<T, M> {
- private List<SingleMemberHandler<T, M>> handlers;
+ private static class MultiMemberHandler<Union, Kind, Member> extends EventHandler<Union, Kind, Member> {
+ private List<SingleMemberHandler<Union, Kind, Member>> handlers;
 
  @Override
  EnumSet<Event> nativeEvents() {
  EnumSet<Event> result = EnumSet.noneOf(Event.class);
- for (SingleMemberHandler<T, M> smh: handlers) {
+ for (SingleMemberHandler<Union, Kind, Member> smh: handlers) {
  result.addAll(smh.deserializer.nativeEvents());
  }
  return result;
  }
 
  @Override
- T deserialize(JsonParser parser, JsonpMapper mapper, Event event, BiFunction<String, M, T> buildFn) {
+ Union deserialize(JsonParser parser, JsonpMapper mapper, Event event, BiFunction<Kind, Member, Union> buildFn) {
  RuntimeException exception = null;
- for (EventHandler<T, M> d: handlers) {
+ for (EventHandler<Union, Kind, Member> d: handlers) {
  try {
  return d.deserialize(parser, mapper, event, buildFn);
  } catch(RuntimeException ex) {
@@ -106,37 +106,37 @@ T deserialize(JsonParser parser, JsonpMapper mapper, Event event, BiFunction<Str
  }
  }
 
- public static class Builder<T, M> implements ObjectBuilder<JsonpDeserializer<T>> {
+ public static class Builder<Union, Kind, Member> implements ObjectBuilder<JsonpDeserializer<Union>> {
 
- private final BiFunction<String, M, T> buildFn;
+ private final BiFunction<Kind, Member, Union> buildFn;
 
- private final List<UnionDeserializer.SingleMemberHandler<T, M>> objectMembers = new ArrayList<>();
- private final Map<Event, EventHandler<T, M>> otherMembers = new HashMap<>();
+ private final List<UnionDeserializer.SingleMemberHandler<Union, Kind, Member>> objectMembers = new ArrayList<>();
+ private final Map<Event, EventHandler<Union, Kind, Member>> otherMembers = new HashMap<>();
  private final boolean allowAmbiguousPrimitive;
 
- public Builder(BiFunction<String, M, T> buildFn, boolean allowAmbiguities) {
+ public Builder(BiFunction<Kind, Member, Union> buildFn, boolean allowAmbiguities) {
  // If we allow ambiguities, multiple handlers for a given json value event will be allowed
  this.allowAmbiguousPrimitive = allowAmbiguities;
  this.buildFn = buildFn;
  }
 
- private void addAmbiguousDeserializer(Event e, String tag, JsonpDeserializer<? extends M> deserializer) {
- EventHandler<T, M> m = otherMembers.get(e);
- MultiMemberHandler<T, M> mmh;
- if (m instanceof MultiMemberHandler<?, ?>) {
- mmh = (MultiMemberHandler<T, M>) m;
+ private void addAmbiguousDeserializer(Event e, Kind tag, JsonpDeserializer<? extends Member> deserializer) {
+ EventHandler<Union, Kind, Member> m = otherMembers.get(e);
+ MultiMemberHandler<Union, Kind, Member> mmh;
+ if (m instanceof MultiMemberHandler<?, ?, ?>) {
+ mmh = (MultiMemberHandler<Union, Kind, Member>) m;
  } else {
  mmh = new MultiMemberHandler<>();
  mmh.handlers = new ArrayList<>(2);
- mmh.handlers.add((SingleMemberHandler<T, M>) m);
+ mmh.handlers.add((SingleMemberHandler<Union, Kind, Member>) m);
  otherMembers.put(e, mmh);
  }
  mmh.handlers.add(new SingleMemberHandler<>(tag, deserializer));
  // Sort handlers by number of accepted events, which gives their specificity
  mmh.handlers.sort(Comparator.comparingInt(a -> a.deserializer.acceptedEvents().size()));
  }
 
- private void addMember(Event e, String tag, UnionDeserializer.SingleMemberHandler<T, M> member) {
+ private void addMember(Event e, Kind tag, UnionDeserializer.SingleMemberHandler<Union, Kind, Member> member) {
  if (otherMembers.containsKey(e)) {
  if (!allowAmbiguousPrimitive || e == Event.START_OBJECT || e == Event.START_ARRAY) {
  throw new AmbiguousUnionException("Union member '" + tag + "' conflicts with other members");
@@ -151,26 +151,26 @@ private void addMember(Event e, String tag, UnionDeserializer.SingleMemberHandle
  }
  }
 
- public Builder<T, M> addMember(String tag, JsonpDeserializer<? extends M> deserializer) {
+ public Builder<Union, Kind, Member> addMember(Kind tag, JsonpDeserializer<? extends Member> deserializer) {
 
  JsonpDeserializer<?> unwrapped = DelegatingDeserializer.unwrap(deserializer);
  if (unwrapped instanceof ObjectDeserializer) {
  ObjectDeserializer<?> od = (ObjectDeserializer<?>) unwrapped;
  Set<String> allFields = od.fieldNames();
  Set<String> fields = new HashSet<>(allFields); // copy to update
- for (UnionDeserializer.SingleMemberHandler<T, M> member: objectMembers) {
+ for (UnionDeserializer.SingleMemberHandler<Union, Kind, Member> member: objectMembers) {
  // Remove respective fields on both sides to keep specific ones
  fields.removeAll(member.fields);
  member.fields.removeAll(allFields);
  }
- UnionDeserializer.SingleMemberHandler<T, M> member = new SingleMemberHandler<>(tag, deserializer, fields);
+ UnionDeserializer.SingleMemberHandler<Union, Kind, Member> member = new SingleMemberHandler<>(tag, deserializer, fields);
  objectMembers.add(member);
  if (od.shortcutProperty() != null) {
  // also add it as a string
  addMember(Event.VALUE_STRING, tag, member);
  }
  } else {
- UnionDeserializer.SingleMemberHandler<T, M> member = new SingleMemberHandler<>(tag, deserializer);
+ UnionDeserializer.SingleMemberHandler<Union, Kind, Member> member = new SingleMemberHandler<>(tag, deserializer);
  for (Event e: deserializer.nativeEvents()) {
  addMember(e, tag, member);
  }
@@ -180,9 +180,9 @@ public Builder<T, M> addMember(String tag, JsonpDeserializer<? extends M> deseri
  }
 
  @Override
- public JsonpDeserializer<T> build() {
+ public JsonpDeserializer<Union> build() {
  // Check that no object member had all its fields removed
- for (UnionDeserializer.SingleMemberHandler<T, M> member: objectMembers) {
+ for (UnionDeserializer.SingleMemberHandler<Union, Kind, Member> member: objectMembers) {
  if (member.fields.isEmpty()) {
  throw new AmbiguousUnionException("All properties of '" + member.tag + "' also exist in other object members");
  }
@@ -201,16 +201,16 @@ public JsonpDeserializer<T> build() {
  }
  }
 
- private final BiFunction<String, M, T> buildFn;
+ private final BiFunction<Kind, Member, Union> buildFn;
  private final EnumSet<Event> nativeEvents;
- private final Map<String, EventHandler<T, M>> objectMembers;
- private final Map<Event, EventHandler<T, M>> otherMembers;
- private final EventHandler<T, M> fallbackObjectMember;
+ private final Map<String, EventHandler<Union, Kind, Member>> objectMembers;
+ private final Map<Event, EventHandler<Union, Kind, Member>> otherMembers;
+ private final EventHandler<Union, Kind, Member> fallbackObjectMember;
 
  public UnionDeserializer(
- List<SingleMemberHandler<T, M>> objectMembers,
- Map<Event, EventHandler<T, M>> otherMembers,
- BiFunction<String, M, T> buildFn
+ List<SingleMemberHandler<Union, Kind, Member>> objectMembers,
+ Map<Event, EventHandler<Union, Kind, Member>> otherMembers,
+ BiFunction<Kind, Member, Union> buildFn
  ) {
  this.buildFn = buildFn;
 
@@ -219,7 +219,7 @@ public UnionDeserializer(
  this.objectMembers = Collections.emptyMap();
  } else {
  this.objectMembers = new HashMap<>();
- for (SingleMemberHandler<T, M> member: objectMembers) {
+ for (SingleMemberHandler<Union, Kind, Member> member: objectMembers) {
  for (String field: member.fields) {
  this.objectMembers.put(field, member);
  }
@@ -229,7 +229,7 @@ public UnionDeserializer(
  this.otherMembers = otherMembers;
 
  this.nativeEvents = EnumSet.noneOf(Event.class);
- for (EventHandler<T, M> member: otherMembers.values()) {
+ for (EventHandler<Union, Kind, Member> member: otherMembers.values()) {
  this.nativeEvents.addAll(member.nativeEvents());
  }
 
@@ -253,15 +253,15 @@ public EnumSet<Event> acceptedEvents() {
  }
 
  @Override
- public T deserialize(JsonParser parser, JsonpMapper mapper) {
+ public Union deserialize(JsonParser parser, JsonpMapper mapper) {
  Event event = parser.next();
  JsonpUtils.ensureAccepts(this, parser, event);
  return deserialize(parser, mapper, event);
  }
 
  @Override
- public T deserialize(JsonParser parser, JsonpMapper mapper, Event event) {
- EventHandler<T, M> member = otherMembers.get(event);
+ public Union deserialize(JsonParser parser, JsonpMapper mapper, Event event) {
+ EventHandler<Union, Kind, Member> member = otherMembers.get(event);
 
  if (member == null && event == Event.START_OBJECT && !objectMembers.isEmpty()) {
  // Parse as an object to find matching field names

java-client/src/main/java/co/elastic/clients/util/MapBuilder.java

@@ -34,13 +34,13 @@ public MapBuilder(Supplier<B> builderCtor) {
  this.builderCtor = builderCtor;
  }
 
- public MapBuilder<K, V, B> entry(K key, V value) {
+ public MapBuilder<K, V, B> put(K key, V value) {
  map.put(key, value);
  return this;
  }
 
- public MapBuilder<K, V, B> entry(K key, Function<B, ObjectBuilder<V>> fn) {
- return entry(key, fn.apply(builderCtor.get()).build());
+ public MapBuilder<K, V, B> put(K key, Function<B, ObjectBuilder<V>> fn) {
+ return put(key, fn.apply(builderCtor.get()).build());
  }
 
  @Override

java-client/src/main/java/co/elastic/clients/util/TaggedUnion.java

@@ -19,22 +19,14 @@
 
 package co.elastic.clients.util;
 
-public interface TaggedUnion<BaseType> {
+public interface TaggedUnion<Tag extends Enum<?>, BaseType> {
 
  /**
- * Get the of the type of the variant held by this union object.
+ * Get the of the kind of variant held by this object.
  *
- * @return the variant type
+ * @return the variant kind
  */
- String _type();
+ Tag _kind();
 
  BaseType _get();
-
- /**
- * Checks if this object is of a given variant type.
- */
- default boolean _is(String type) {
- return _type().equals(type);
- }
-
 }