Fix StreamingSample checkstyle

Bill Prin · Bill Prin · commit 78daa804edca · 2015-05-28T14:20:53.000-07:00
diff --git a/bigquery/src/main/java/com/google/cloud/bigquery/samples/StreamingSample.java b/bigquery/src/main/java/com/google/cloud/bigquery/samples/StreamingSample.java
@@ -1,15 +1,15 @@
 /*
-	Copyright 2015, Google, Inc. 
- Licensed under the Apache License, Version 2.0 (the "License"); 
- you may not use this file except in compliance with the License. 
- You may obtain a copy of the License at 
-  
-    http://www.apache.org/licenses/LICENSE-2.0 
-  
- Unless required by applicable law or agreed to in writing, software 
- distributed under the License is distributed on an "AS IS" BASIS, 
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
- See the License for the specific language governing permissions and 
+ Copyright 2015, Google, Inc.
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
  limitations under the License.
 */
 package com.google.cloud.bigquery.samples;
@@ -31,14 +31,25 @@
 
 
 /**
- * TODO: Insert description here. (generated by elibixby)
+ * Example of Bigquery Streaming.
  */
-public class StreamingSample extends BigqueryUtils {
+public class StreamingSample  {
+
+    /**
+     * Empty constructor since this is just a collection of static methods.
+     */
+    protected StreamingSample() {
+
+    }
+
 
-  
-  
+    /**
+     * Command line that demonstrates Bigquery streaming.
+     * @param args Command line args, should be empty
+     * @throws IOException IOexception
+     */
   // [START main]
-  public static void main(String[] args) throws IOException{
+  public static void main(final String[] args) throws IOException {
     final Scanner scanner = new Scanner(System.in);
     System.out.println("Enter your project id: ");
     String projectId = scanner.nextLine();
@@ -47,54 +58,70 @@ public static void main(String[] args) throws IOException{
     System.out.println("Enter your table id: ");
     String tableId = scanner.nextLine();
     scanner.close();
-    
+
     System.out.println("Enter JSON to stream to BigQuery: \n"
         + "Press End-of-stream (CTRL-D) to stop");
-    
+
     JsonReader fromCLI = new JsonReader(new InputStreamReader(System.in));
-    
+
     Iterator<TableDataInsertAllResponse> responses = run(projectId,
         datasetId,
         tableId,
         fromCLI);
-    
-    while(responses.hasNext()){
+
+    while (responses.hasNext()) {
       System.out.println(responses.next());
     }
-    
+
     fromCLI.close();
   }
   // [END main]
-  
-  
-  
-// [START run] 
+
+
+  /**
+   * Run the bigquery ClI.
+   * @param projectId Project id
+   * @param datasetId datasetid
+   * @param tableId tableid
+   * @param rows The source of the JSON rows we are streaming in.
+   * @return Returns Iterates through the stream responses
+   * @throws IOException Thrown if there is an error connecting to Bigquery.
+   * @throws InterruptedException Should never be thrown
+   */
+  // [START run]
   public static Iterator<TableDataInsertAllResponse> run(final String projectId,
-      final String datasetId, 
+      final String datasetId,
       final String tableId,
-      final JsonReader rows) throws IOException{
-    
-    
+      final JsonReader rows) throws IOException {
+
+
     final Bigquery bigquery = BigqueryServiceFactory.getService();
     final Gson gson = new Gson();
     rows.beginArray();
-    
-    return new Iterator<TableDataInsertAllResponse>(){
 
+    return new Iterator<TableDataInsertAllResponse>() {
+
+        /**
+         * Get the next row in the stream
+         * @return True if there is another row in the stream
+         */
       public boolean hasNext() {
         try {
           return rows.hasNext();
         } catch (IOException e) {
-          // TODO(elibixby): Auto-generated catch block
           e.printStackTrace();
         }
         return false;
       }
 
+        /**
+         *
+         * @return Next page of data
+         */
       public TableDataInsertAllResponse next() {
         try {
           Map<String, Object> rowData = gson.<Map<String, Object>>fromJson(
-              rows, 
+              rows,
               (new HashMap<String, Object>()).getClass());
           return streamRow(bigquery,
               projectId,
@@ -112,25 +139,35 @@ public TableDataInsertAllResponse next() {
       public void remove() {
         this.next();
       }
-      
+
     };
-    
+
   }
 // [END run]
-  
+
+  /**
+   *
+   * @param bigquery The bigquery service
+   * @param projectId project id from Google Developers console
+   * @param datasetId  id of teh dataset
+   * @param tableId if the table we're streaming
+   * @param row Id of the row we're inserting
+   * @return Response from the insert
+   * @throws IOException ioexception
+   */
 // [START streamRow]
-  public static TableDataInsertAllResponse streamRow(Bigquery bigquery,
-      String projectId,
-      String datasetId,
-      String tableId,
-      TableDataInsertAllRequest.Rows row) throws IOException{
-    
+  public static TableDataInsertAllResponse streamRow(final Bigquery bigquery,
+      final String projectId,
+      final String datasetId,
+      final String tableId,
+      final TableDataInsertAllRequest.Rows row) throws IOException {
+
     return bigquery.tabledata().insertAll(
-        projectId, 
-        datasetId, 
-        tableId, 
-        new TableDataInsertAllRequest().setRows(Collections.singletonList(row))).execute();
-    
+        projectId,
+        datasetId,
+        tableId,
+        new TableDataInsertAllRequest().setRows(
+                Collections.singletonList(row))).execute();
   }
 // [END streamRow]
 }
