javadoc + validation + test

Author: slisaasquatch

src/main/java/com/saasquatch/jsonschemainferrer/EnumExtractor.java

@@ -4,9 +4,21 @@
 import javax.annotation.Nonnull;
 import com.fasterxml.jackson.databind.JsonNode;
 
+/**
+ * Interface for extracting {@code enum} groups from samples.
+ *
+ * @author sli
+ * @see EnumExtractors
+ * @see EnumExtractorInput
+ */
 @FunctionalInterface
 public interface EnumExtractor {
 
+  /**
+   * @return The <em>group</em> of enums. Note that each group is expected to be not null and not
+   *         empty. All the elements in each group are expected to come directly from the given
+   *         samples if possible to ensure {@link JsonNode#equals(Object)} works correctly.
+   */
   @Nonnull
   Set<Set<? extends JsonNode>> extractEnums(@Nonnull EnumExtractorInput input);
 

src/main/java/com/saasquatch/jsonschemainferrer/EnumExtractorInput.java

@@ -4,6 +4,11 @@
 import javax.annotation.Nonnull;
 import com.fasterxml.jackson.databind.JsonNode;
 
+/**
+ * Input for {@link EnumExtractor}
+ *
+ * @author sli
+ */
 public final class EnumExtractorInput {
 
   private final Collection<? extends JsonNode> samples;
@@ -15,10 +20,18 @@ public final class EnumExtractorInput {
     this.specVersion = specVersion;
   }
 
+  /**
+   * @return The current samples
+   */
+  @Nonnull
   public Collection<? extends JsonNode> getSamples() {
     return samples;
   }
 
+  /**
+   * @return The current {@link SpecVersion}
+   */
+  @Nonnull
   public SpecVersion getSpecVersion() {
     return specVersion;
   }

src/main/java/com/saasquatch/jsonschemainferrer/JsonSchemaInferrer.java

@@ -248,6 +248,19 @@ private Set<ObjectNode> processPrimitives(@Nonnull Collection<ValueNode> valueNo
     return anyOfs;
   }
 
+  @Nonnull
+  private ObjectNode enumExtractionResultToSchema(
+      @Nonnull Set<? extends JsonNode> enumExtractionResult) {
+    Objects.requireNonNull(enumExtractionResult);
+    if (enumExtractionResult.isEmpty()) {
+      throw new IllegalStateException("Empty enum group encountered");
+    }
+    final ObjectNode schema = newObject();
+    schema.set(Consts.Fields.ENUM, newArray(enumExtractionResult));
+    processGenericSchemaFeature(schema, enumExtractionResult, null);
+    return schema;
+  }
+
   /**
    * Build {@code anyOf} from sample JSONs. Note that all the arrays and objects will be combined.
    *
@@ -277,12 +290,7 @@ private Set<ObjectNode> getAnyOfsFromSamples(
     }
     final Set<ObjectNode> anyOfs = new HashSet<>();
     // Enums
-    for (Set<? extends JsonNode> enumExtractionResult : enumExtractionResults) {
-      final ObjectNode anyOf = newObject();
-      anyOf.set(Consts.Fields.ENUM, newArray(enumExtractionResult));
-      processGenericSchemaFeature(anyOf, enumExtractionResult, null);
-      anyOfs.add(anyOf);
-    }
+    enumExtractionResults.stream().map(this::enumExtractionResultToSchema).forEach(anyOfs::add);
     // Objects
     final ObjectNode resultForObjects = processObjects(objectNodes);
     if (resultForObjects != null) {

src/main/java/com/saasquatch/jsonschemainferrer/JsonSchemaInferrerBuilder.java

@@ -51,6 +51,8 @@ public JsonSchemaInferrerBuilder setSpecVersion(@Nonnull SpecVersion specVersion
 
   /**
    * Set the {@link IntegerTypePreference}. The default is {@link IntegerTypePreference#IF_ALL}.
+   *
+   * @see IntegerTypePreference
    */
   public JsonSchemaInferrerBuilder setIntegerTypePreference(
       @Nonnull IntegerTypePreference integerTypePreference) {
@@ -61,13 +63,22 @@ public JsonSchemaInferrerBuilder setIntegerTypePreference(
   /**
    * Set the {@link IntegerTypeCriterionL}. The default is
    * {@link IntegerTypeCriteria#nonFloatingPoint()}.
+   *
+   * @see IntegerTypeCriterion
+   * @see IntegerTypeCriteria
    */
   public JsonSchemaInferrerBuilder setIntegerTypeCriterion(
       @Nonnull IntegerTypeCriterion integerTypeCriterion) {
     this.integerTypeCriterion = Objects.requireNonNull(integerTypeCriterion);
     return this;
   }
 
+  /**
+   * Set the {@link EnumExtractor}. The default is {@link EnumExtractors#noOp()}.
+   *
+   * @see EnumExtractor
+   * @see EnumExtractors
+   */
   public JsonSchemaInferrerBuilder setEnumExtractor(@Nonnull EnumExtractor enumExtractor) {
     this.enumExtractor = Objects.requireNonNull(enumExtractor);
     return this;

src/test/java/com/saasquatch/jsonschemainferrer/JsonSchemaInferrerOptionsTest.java

@@ -547,6 +547,11 @@ public void testEnum() {
       assertTrue(stream(anyOf)
           .anyMatch(_anyOf -> _anyOf.path("enum").get(0).textValue().equals("TUESDAY")));
     }
+    {
+      final JsonSchemaInferrer inferrer = JsonSchemaInferrer.newBuilder()
+          .setEnumExtractor(input -> Collections.singleton(Collections.emptySet())).build();
+      assertThrows(IllegalStateException.class, () -> inferrer.inferForSample(null));
+    }
   }
 
   @Test