org.infinispan.protostream.schema.Message Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protostream Show documentation
Users need to implement a marshaller object that interacts with a field writer/reader in order to serialize state.
There is a newer version: 14.0.0.CR2
package org.infinispan.protostream.schema;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;
import java.util.stream.Collectors;

import org.infinispan.protostream.impl.Log;
import org.infinispan.protostream.impl.SparseBitSet;

/**
 * @since 5.0
 */
public class Message {
   private final String name;
   private final String fullName;
   private final java.util.Map nestedEnums;
   private final java.util.Map nestedMessages;
   private final java.util.Map fields;
   private final List oneOfs;
   private final SparseBitSet reservedNumbers;
   private final Set reservedNames;
   private final java.util.Map options;
   private final List comments;

   Message(Builder builder) {
      this.name = builder.name;
      this.fullName = builder.getFullName();
      this.nestedEnums = builder.nestedEnums.entrySet().stream().collect(Collectors.toUnmodifiableMap(java.util.Map.Entry::getKey, e -> e.getValue().create()));
      this.nestedMessages = builder.nestedMessages.entrySet().stream().collect(Collectors.toUnmodifiableMap(java.util.Map.Entry::getKey, e -> e.getValue().create()));
      AtomicInteger autoNumber = new AtomicInteger(1);
      this.fields = builder.fields.entrySet().stream().collect(Collectors.toUnmodifiableMap(java.util.Map.Entry::getKey, e -> e.getValue().create(autoNumber)));
      this.oneOfs = builder.oneOfs.values().stream().map(e -> e.create(autoNumber)).toList();
      this.reservedNumbers = builder.reservedNumbers;
      this.reservedNames = Set.copyOf(builder.reservedNames);
      this.options = java.util.Map.copyOf(builder.options);
      this.comments = List.copyOf(builder.comments);
   }

   public String getName() {
      return name;
   }

   public String getFullName() {
      return fullName;
   }

   public java.util.Map getNestedEnums() {
      return nestedEnums;
   }

   public java.util.Map getNestedMessages() {
      return nestedMessages;
   }

   public java.util.Map getFields() {
      return fields;
   }

   public List getOneOfs() {
      return oneOfs;
   }

   public ReservedNumbers getReservedNumbers() {
      return reservedNumbers;
   }

   public Set getReservedNames() {
      return reservedNames;
   }

   public java.util.Map getOptions() {
      return options;
   }

   public List getComments() {
      return comments;
   }

   public static class Builder implements CommentContainer, MessageContainer, FieldContainer, OptionContainer, ReservedContainer, EnumContainer {
      private final Schema.Builder schema;
      private final String name;
      private final java.util.Map nestedEnums = new HashMap<>();
      private final java.util.Map nestedMessages = new HashMap<>();
      private final java.util.Map fields = new HashMap<>();
      private final java.util.Map oneOfs = new HashMap<>();
      private final SparseBitSet reservedNumbers = new SparseBitSet();
      private final Set reservedNames = new HashSet<>();
      private final java.util.Map options = new HashMap<>();
      private final List comments = new ArrayList<>();
      private final GenericContainer parent;

      Builder(Schema.Builder schema, String name) {
         this.schema = schema;
         this.name = name;
         this.parent = schema;
      }

      Builder(Builder builder, String name) {
         this.schema = builder.schema;
         this.name = name;
         this.parent = builder;
      }

      @Override
      public Message.Builder addMessage(String name) {
         Objects.requireNonNull(name, "name must not be null");
         return schema.addMessage(name);
      }

      @Override
      public Builder addNestedEnum(String name, Consumer nested) {
         Objects.requireNonNull(name, "name must not be null");
         Objects.requireNonNull(nested, "nested must not be null");
         Enum.Builder e = new Enum.Builder(this, name);
         nestedEnums.put(name, e);
         nested.accept(e);
         return this;
      }

      @Override
      public Builder addNestedMessage(String name, Consumer nested) {
         Objects.requireNonNull(name, "name must not be null");
         Objects.requireNonNull(nested, "nested must not be null");
         Message.Builder message = new Message.Builder(this, name);
         nestedMessages.put(name, message);
         nested.accept(message);
         return this;
      }

      @Override
      public Builder addOption(String name, Object value) {
         Objects.requireNonNull(name, "name must not be null");
         Objects.requireNonNull(value, "value must not be null");
         options.put(name, value);
         return this;
      }

      @Override
      public Message.Builder addComment(String comment) {
         Objects.requireNonNull(comment, "comment must not be null");
         comments.add(comment.trim());
         return this;
      }

      @Override
      public Field.Builder addField(Type type, String name, int number) {
         Objects.requireNonNull(type, "type must not be null");
         Objects.requireNonNull(name, "name must not be null");
         checkDuplicate(name);
         Field.Builder field = new Field.Builder(this, type, name, number, false);
         fields.put(name, field);
         return field;
      }

      @Override
      public Field.Builder addRepeatedField(Type type, String name, int number) {
         Objects.requireNonNull(type, "type must not be null");
         Objects.requireNonNull(name, "name must not be null");
         checkDuplicate(name);
         Field.Builder field = new Field.Builder(this, type, name, number, true);
         fields.put(name, field);
         return field;
      }

      @Override
      public Map.Builder addMap(Type.Scalar keyType, Type valueType, String name, int number) {
         Objects.requireNonNull(keyType, "keyType must not be null");
         Objects.requireNonNull(valueType, "valueType must not be null");
         Objects.requireNonNull(name, "name must not be null");
         checkDuplicate(name);
         Map.Builder map = new Map.Builder(this, keyType, valueType, name, number);
         fields.put(name, map);
         return map;
      }

      @Override
      public Builder addOneOf(String name, Consumer oneof) {
         Objects.requireNonNull(name, "name must not be null");
         Objects.requireNonNull(oneof, "oneof must not be null");
         checkDuplicate(name);
         OneOf.Builder builder = new OneOf.Builder(this, name);
         oneOfs.put(name, builder);
         oneof.accept(builder);
         return this;
      }

      @Override
      public Builder addReserved(int... numbers) {
         Objects.requireNonNull(numbers, "number array must not be null");
         for (int number : numbers) {
            reservedNumbers.set(number);
         }
         return this;
      }

      @Override
      public Builder addReservedRange(int from, int to) {
         reservedNumbers.set(from, to + 1);
         return this;
      }

      @Override
      public Builder addReserved(String name) {
         Objects.requireNonNull(name, "name must not be null");
         reservedNames.add(name);
         return this;
      }

      @Override
      public Enum.Builder addEnum(String name) {
         return schema.addEnum(name);
      }

      Message create() {
         validate();
         return new Message(this);
      }

      private void validate() {
         Boolean autoGenerateNumbers = null;
         for (Field.Builder fb : fields.values()) {
            if (reservedNames.contains(fb.name)) {
               throw Log.LOG.reservedName(fb.name, name);
            }
            if (fb.number == 0) {
               if (Boolean.FALSE.equals(autoGenerateNumbers)) {
                  throw Log.LOG.cannotMixAutoGeneratedNumbers(name);
               } else {
                  autoGenerateNumbers = Boolean.TRUE;
               }
            } else {
               if (reservedNumbers.get(fb.number)) {
                  throw Log.LOG.reservedNumber(fb.number, fb.name, name);
               }
               if (Boolean.TRUE.equals(autoGenerateNumbers)) {
                  throw Log.LOG.cannotMixAutoGeneratedNumbers(name);
               } else {
                  autoGenerateNumbers = Boolean.FALSE;
               }
            }
         }
         for (OneOf.Builder ob : oneOfs.values()) {
            for (OneOf.FieldBuilder fb : ob.getFields().values()) {
               if (reservedNames.contains(fb.builder.name)) {
                  throw Log.LOG.reservedName(fb.builder.name, ob.getFullName());
               }
               if (reservedNumbers.get(fb.builder.number)) {
                  throw Log.LOG.reservedNumber(fb.builder.number, fb.builder.name, ob.getFullName());
               }
            }
         }
         if (Boolean.TRUE.equals(autoGenerateNumbers) && !reservedNumbers.isEmpty()) {
            throw Log.LOG.cannotMixAutoGeneratedNumbers(name);
         }
      }

      @Override
      public Schema build() {
         return schema.build();
      }

      @Override
      public String getFullName() {
         return parent.getFullName() + '.' + name;
      }


      private void checkDuplicate(String name) {
         if (fields.containsKey(name) || oneOfs.containsKey(name)) {
            throw new IllegalArgumentException("Duplicate field name " + name);
         }
      }
   }
}