Fix style in BigqueryServiceFactory

Bill Prin · Bill Prin · commit 99a753365cc2 · 2015-05-28T12:07:52.000-07:00
diff --git a/bigquery/src/main/java/com/google/cloud/bigquery/samples/BigqueryServiceFactory.java b/bigquery/src/main/java/com/google/cloud/bigquery/samples/BigqueryServiceFactory.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.
  */
 
@@ -25,32 +27,61 @@
 import java.io.IOException;
 import java.util.Collection;
 
-public class BigqueryServiceFactory {
+/**
+ * This class creates our Service to connect to Bigquery including auth.
+ */
+public final class BigqueryServiceFactory {
+
+  /**
+   * Private constructor to disable creation of this utility Factory class.
+   */
+  private BigqueryServiceFactory() {
 
+  }
+
+  /**
+   * Singleton service used through the app.
+   */
   private static Bigquery service = null;
-  private static Object service_lock = new Object();
 
-  public static Bigquery getService() throws IOException{
-    if(service==null){
-      synchronized(service_lock){
-        if(service==null){
-          service=createAuthorizedClient();
+  /**
+   * Mutex created to create the singleton in thread-safe fashion.
+   */
+  private static Object serviceLock = new Object();
+
+  /**
+   * Threadsafe Factory that provides an authorized Bigquery service.
+   * @return The Bigquery service
+   * @throws IOException Thronw if there is an error connecting to Bigquery.
+   */
+  public static Bigquery getService() throws IOException {
+    if (service == null) {
+      synchronized (serviceLock) {
+        if (service == null) {
+          service = createAuthorizedClient();
         }
       }
     }
     return service;
   }
 
+  /**
+   * Creates an authorized client to Google Bigquery.
+   * @return The BigQuery Service
+   * @throws IOException Thrown if there is an error connecting
+   */
   // [START get_service]
   private static Bigquery createAuthorizedClient() throws IOException {
-    Collection<String> BIGQUERY_SCOPES = BigqueryScopes.all();
-    HttpTransport TRANSPORT = new NetHttpTransport();
-    JsonFactory JSON_FACTORY = new JacksonFactory();
-    GoogleCredential credential = GoogleCredential.getApplicationDefault(TRANSPORT, JSON_FACTORY);
-    if(credential.createScopedRequired()){
-      credential = credential.createScoped(BIGQUERY_SCOPES);
+    Collection<String> bigqueryScopes = BigqueryScopes.all();
+    HttpTransport transport = new NetHttpTransport();
+    JsonFactory jsonFactory = new JacksonFactory();
+    GoogleCredential credential =  GoogleCredential.getApplicationDefault(
+            transport, jsonFactory);
+    if (credential.createScopedRequired()) {
+      credential = credential.createScoped(bigqueryScopes);
     }
-    return new Bigquery.Builder(TRANSPORT, JSON_FACTORY, credential).setApplicationName("BigQuery Samples").build();
+    return new Bigquery.Builder(transport, jsonFactory, credential)
+            .setApplicationName("BigQuery Samples").build();
   }
   // [END get_service]
 
