add OR union data provider

Author: tminglei

example/java-jaxrs/src/main/java/com/example/resource/PetResource.java

@@ -22,6 +22,7 @@
 import com.example.data.PetData;
 import com.example.exception.BadRequestException;
 import com.example.exception.NotFoundException;
+import com.github.javafaker.Faker;
 import com.github.tminglei.bind.BindObject;
 import com.github.tminglei.bind.FormBinder;
 import com.github.tminglei.bind.Messages;
@@ -49,7 +50,7 @@ public class PetResource {
     static Mapping<?> petStatus = $(text(oneOf(Arrays.asList("available", "pending", "sold"))))
             .desc("pet status in the store").example("available").$$;
     static Mapping<?> pet = $(mapping(
-            field("id", $(longv()).desc("pet id").example(gen("petId")).$$),
+            field("id", $(longv()).desc("pet id").example(gen("petId").or(gen(() -> new Faker().number().randomNumber()))).$$),
             field("name", $(text(required())).desc("pet name").$$),
             field("category", $(mapping(
                     field("id", longv(required())),

src/main/java/com/github/tminglei/swagger/fake/DataProvider.java

@@ -31,4 +31,11 @@ default void setRequired(boolean required) {}
      */
     Object get();
 
+
+    ///---
+
+    default DataProvider or(DataProvider other) {
+        return new OrDataProvider(this, other);
+    }
+
 }

src/main/java/com/github/tminglei/swagger/fake/DataProviders.java

@@ -43,6 +43,7 @@ public static void setInstance(DataProviders instance) {
     /**
      * collect data providers from schema
      *
+     * @param swagger the hosting swagger object
      * @param schema  the schema object
      * @param clean   whether to clean data providers in the schema
      * @return  organized data provider

src/main/java/com/github/tminglei/swagger/fake/DataWriter.java

@@ -14,6 +14,7 @@ public interface DataWriter {
      * @param writer    target writer
      * @param format    target format
      * @param provider  data provider
+     * @throws IOException
      */
     void write(Writer writer, String format, DataProvider provider) throws IOException;
 

src/main/java/com/github/tminglei/swagger/fake/OrDataProvider.java

@@ -0,0 +1,39 @@
+package com.github.tminglei.swagger.fake;
+
+import java.util.Map;
+import java.util.Optional;
+
+/**
+ * Created by minglei on 4/23/17.
+ */
+public class OrDataProvider implements DataProvider {
+    private DataProvider first;
+    private DataProvider second;
+
+    public OrDataProvider(DataProvider first, DataProvider second) {
+        this.first = first;
+        this.second = second;
+    }
+
+    @Override
+    public void setRequestParams(Map<String, String> params) {
+        first.setRequestParams(params);
+        second.setRequestParams(params);
+    }
+
+    @Override
+    public void setRequired(boolean required) {
+        first.setRequired(required);
+        second.setRequired(required);
+    }
+
+    @Override
+    public String name() {
+        return first.name();
+    }
+
+    @Override
+    public Object get() {
+        return Optional.ofNullable(first.get()).orElseGet(second::get);
+    }
+}

src/main/java/com/github/tminglei/swagger/route/Route.java

@@ -25,7 +25,7 @@ public interface Route {
     /**
      *
      * @param path request path, should match the binded path pattern
-     * @return
+     * @return params extracted from path
      */
     Map<String, String> getPathParams(String path);
 

src/main/java/com/github/tminglei/swagger/route/RouteImpl.java

@@ -141,6 +141,8 @@ public List<PathStaticElement> getStaticPathElements() {
     /**
      * Use of this method assumes the path given matches this Route.
      *
+     * @param paramName param name
+     * @param path      path
      * @return the value of the named parameter in the path, or null if
      *         no named parameter exists with the given name
      */
@@ -159,6 +161,8 @@ public String getNamedParameter(String paramName, String path) {
     /**
      * Use of this method assumes the path given matches this Route.
      *
+     * @param index the param index
+     * @param path  path
      * @return the value of the splat parameter at the given index,
      *         or null if the splat parameter index does not exist
      */
@@ -172,6 +176,9 @@ public String getSplatParameter(int index, String path) {
 
     /**
      * Use of this method assumes the path given matches this Route.
+     *
+     * @param path  path
+     * @return splat params' values
      */
     public String[] splat(String path) {
         List<PathSplatParamElement> splatParams = getSplatParameterElements();