Finish fixing Async Query and Defer Sample

Bill Prin · Bill Prin · commit 0e4514f83369 · 2015-05-28T11:58:38.000-07:00
Also add Takashi’s rule
diff --git a/bigquery/src/main/java/com/google/cloud/bigquery/samples/AsyncQuerySample.java b/bigquery/src/main/java/com/google/cloud/bigquery/samples/AsyncQuerySample.java
@@ -1,14 +1,16 @@
 /**
  * Copyright (c) 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
+ * 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
+ * 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.
  */
 
@@ -30,16 +32,16 @@
 /**
  * Example of authorizing with BigQuery and reading from a public dataset.
  */
-public class AsyncQuerySample extends BigqueryUtils{
+public class AsyncQuerySample extends BigqueryUtils {
 
 
   // [START main]
   /**
-   * @param args
-   * @throws IOException
-   * @throws InterruptedException
+   * @param args Command line args
+   * @throws IOException IOException
+   * @throws InterruptedException InterruptedException
    */
-  public static void main(String[] args)
+  public static void main(final String[] args)
       throws IOException, InterruptedException {
 
     Scanner scanner = new Scanner(System.in);
@@ -49,23 +51,35 @@ public static void main(String[] args)
     String queryString = scanner.nextLine();
     System.out.println("Run query in batch mode? [true|false] ");
     boolean batch = Boolean.valueOf(scanner.nextLine());
-    System.out.println("Enter how often to check if your job is complete (milliseconds): ");
+    System.out.println("Enter how often to check if your job is complete "
+            + "(milliseconds): ");
     long waitTime = scanner.nextLong();
     scanner.close();
-    Iterator<GetQueryResultsResponse> pages = run(projectId, queryString, batch, waitTime);
-    while(pages.hasNext()){
+    Iterator<GetQueryResultsResponse> pages = run(projectId, queryString,
+            batch, waitTime);
+    while (pages.hasNext()) {
       printRows(pages.next().getRows(), System.out);
     }
 
   }
   // [END main]
-
   // [START run]
-  public static Iterator<GetQueryResultsResponse> run(String projectId,
-      String queryString,
-      boolean batch,
-      long waitTime)
-      throws IOException, InterruptedException{
+
+  /**
+   *
+   * @param projectId Get this from Google Developers console
+   * @param queryString Query we want to run against BigQuery
+   * @param batch True if you want to batch the queries
+   * @param waitTime How long to wait before retries
+   * @return An interator to the result of your pages
+   * @throws IOException Thrown if there's an IOException
+   * @throws InterruptedException Thrown if there's an Interrupted Exception
+   */
+   public static Iterator<GetQueryResultsResponse> run(final String projectId,
+      final String queryString,
+      final boolean batch,
+      final long waitTime)
+      throws IOException, InterruptedException {
 
     Bigquery bigquery = BigqueryServiceFactory.getService();
 
@@ -86,28 +100,29 @@ public static Iterator<GetQueryResultsResponse> run(String projectId,
 
   // [START asyncQuery]
   /**
-   * Inserts an asynchronous query Job for a particular query
+   * Inserts an asynchronous query Job for a particular query.
    *
    * @param bigquery  an authorized BigQuery client
    * @param projectId a String containing the project ID
    * @param querySql  the actual query string
+   * @param batch True if you want to run the query as BATCH
    * @return a reference to the inserted query job
-   * @throws IOException
+   * @throws IOException Thrown if there's a network exception
    */
-  public static Job asyncQuery(Bigquery bigquery,
-      String projectId,
-      String querySql,
-      boolean batch) throws IOException {
+  public static Job asyncQuery(final Bigquery bigquery,
+      final String projectId,
+      final String querySql,
+      final boolean batch) throws IOException {
 
-    JobConfigurationQuery query_config = new JobConfigurationQuery()
+    JobConfigurationQuery queryConfig = new JobConfigurationQuery()
           .setQuery(querySql);
 
-    if(batch){
-      query_config.setPriority("BATCH");
+    if (batch) {
+      queryConfig.setPriority("BATCH");
     }
 
     Job job = new Job().setConfiguration(
-        new JobConfiguration().setQuery(query_config));
+        new JobConfiguration().setQuery(queryConfig));
 
     return bigquery.jobs().insert(projectId, job).execute();
   }
diff --git a/checkstyle-checker.xml b/checkstyle-checker.xml
@@ -177,6 +177,11 @@
         <module name="TodoComment"/>
         <module name="UpperEll"/>
 
+        <module name="HiddenField">
+          <property name="ignoreSetter" value="true" />
+          <property name="ignoreConstructorParameter" value="true" />
+        </module>
+
     </module>
 
     <!-- Support @SuppressWarnings (added in Checkstyle 5.7) -->
diff --git a/taskqueue/deferred/src/main/java/com/google/cloud/taskqueue/samples/DeferSampleServlet.java b/taskqueue/deferred/src/main/java/com/google/cloud/taskqueue/samples/DeferSampleServlet.java
@@ -59,8 +59,8 @@ public void run() {
      * @param resp servlet response
      */
     @Override
-    public void doGet(HttpServletRequest request, HttpServletResponse
-            resp) throws IOException {
+    public void doGet(final HttpServletRequest request, final
+    HttpServletResponse resp) throws IOException {
         // Add the task to the default queue.
         Queue queue = QueueFactory.getDefaultQueue();
 
