docs: create sample code to stream document (#43)

Author: hdhayneCoveo

samples/StreamDocuments.java

@@ -0,0 +1,34 @@
+import com.coveo.pushapiclient.*;
+import com.coveo.pushapiclient.exceptions.NoOpenStreamException;
+
+import java.io.IOException;
+import java.util.HashMap;
+
+public class StreamDocuments {
+
+    public static void main(String[] args) throws IOException, InterruptedException, NoOpenStreamException {
+
+        PlatformUrl platformUrl = new PlatformUrlBuilder().withEnvironment(Environment.PRODUCTION).withRegion(Region.US).build();
+        CatalogSource catalogSource = CatalogSource.fromPlatformUrl("my_api_key","my_org_id","my_source_id", platformUrl);
+
+        StreamService streamService = new StreamService(catalogSource);
+
+        DocumentBuilder document1 = new DocumentBuilder("https://my.document.uri", "My document title")
+                .withData("these words will be searchable")
+                .withAuthor("bob")
+                .withClickableUri("https://my.document.click.com")
+                .withFileExtension(".html")
+                .withMetadata(new HashMap<>() {{
+                    put("tags", new String[]{"the_first_tag", "the_second_tag"});
+                    put("version", 1);
+                    put("somekey", "somevalue");
+                }});
+
+        streamService.add(document1);
+
+        DocumentBuilder document2 = new DocumentBuilder("https://my.document2.uri", "My document2 title");
+        streamService.add(document2);
+
+        streamService.close();
+    }
+}

src/main/java/com/coveo/pushapiclient/StreamService.java

@@ -62,7 +62,7 @@ public StreamService(StreamEnabledSource source) {
    * </pre>
    *
    * <p>
-   * For more code samples, visit <a href="TODO: LENS-840">Stream data to your catalog source</a>
+   * For more code samples, @see `samples/StreamDocuments.java`
    *
    * @param document The documentBuilder to add to your source
    * @throws InterruptedException