Skip to content

Commit d03e5a7

Browse files
committed
Merge pull request #529 from ajkannan/docs-cleanup
Docs and code cleanup
2 parents b1ff62b + ea21d23 commit d03e5a7

File tree

30 files changed

+124
-119
lines changed

30 files changed

+124
-119
lines changed

gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/BaseTableInfo.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ public enum Type {
9797
/**
9898
* Base builder for tables.
9999
*
100-
* @param <T> the table type.
101-
* @param <B> the table builder.
100+
* @param <T> the table type
101+
* @param <B> the table builder
102102
*/
103103
public abstract static class Builder<T extends BaseTableInfo, B extends Builder<T, B>> {
104104

gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/BigQuery.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -500,31 +500,31 @@ public static QueryResultsOption maxWaitTime(long maxWaitTime) {
500500
/**
501501
* Deletes the requested dataset.
502502
*
503-
* @return {@code true} if dataset was deleted, {@code false} if it was not found.
503+
* @return {@code true} if dataset was deleted, {@code false} if it was not found
504504
* @throws BigQueryException upon failure
505505
*/
506506
boolean delete(String datasetId, DatasetDeleteOption... options) throws BigQueryException;
507507

508508
/**
509509
* Deletes the requested dataset.
510510
*
511-
* @return {@code true} if dataset was deleted, {@code false} if it was not found.
511+
* @return {@code true} if dataset was deleted, {@code false} if it was not found
512512
* @throws BigQueryException upon failure
513513
*/
514514
boolean delete(DatasetId datasetId, DatasetDeleteOption... options) throws BigQueryException;
515515

516516
/**
517517
* Deletes the requested table.
518518
*
519-
* @return {@code true} if table was deleted, {@code false} if it was not found.
519+
* @return {@code true} if table was deleted, {@code false} if it was not found
520520
* @throws BigQueryException upon failure
521521
*/
522522
boolean delete(String datasetId, String tableId) throws BigQueryException;
523523

524524
/**
525525
* Deletes the requested table.
526526
*
527-
* @return {@code true} if table was deleted, {@code false} if it was not found.
527+
* @return {@code true} if table was deleted, {@code false} if it was not found
528528
* @throws BigQueryException upon failure
529529
*/
530530
boolean delete(TableId tableId) throws BigQueryException;

gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Dataset.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ public Dataset update(DatasetInfo datasetInfo, BigQuery.DatasetOption... options
184184
/**
185185
* Deletes this dataset.
186186
*
187-
* @return {@code true} if dataset was deleted, {@code false} if it was not found.
187+
* @return {@code true} if dataset was deleted, {@code false} if it was not found
188188
* @throws BigQueryException upon failure
189189
*/
190190
public boolean delete() {

gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/JobInfo.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
*
3434
* @see <a href="https://cloud.google.com/bigquery/docs/reference/v2/jobs">Jobs</a>
3535
*
36-
* @param <S> the statistics type.
36+
* @param <S> the statistics type
3737
*/
3838
public abstract class JobInfo<S extends JobStatistics> implements Serializable {
3939

@@ -92,9 +92,9 @@ public enum WriteDisposition {
9292
/**
9393
* Base builder for jobs.
9494
*
95-
* @param <T> the job type.
96-
* @param <S> the job statistics type.
97-
* @param <B> the job builder.
95+
* @param <T> the job type
96+
* @param <S> the job statistics type
97+
* @param <B> the job builder
9898
*/
9999
public abstract static class Builder<T extends JobInfo, S extends JobStatistics,
100100
B extends Builder<T, S, B>> {

gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/testing/RemoteBigQueryHelper.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public BigQueryOptions options() {
6060
*
6161
* @param bigquery the BigQuery service to be used to issue the delete request
6262
* @param dataset the dataset to be deleted
63-
* @return {@code true} if deletion succeeded, {@code false} if the dataset was not found.
63+
* @return {@code true} if deletion succeeded, {@code false} if the dataset was not found
6464
* @throws BigQueryException upon failure
6565
*/
6666
public static boolean forceDelete(BigQuery bigquery, String dataset) {
@@ -80,7 +80,7 @@ public static String generateDatasetName() {
8080
*
8181
* @param projectId id of the project to be used for running the tests
8282
* @param keyStream input stream for a JSON key
83-
* @return A {@code RemoteBigQueryHelper} object for the provided options.
83+
* @return A {@code RemoteBigQueryHelper} object for the provided options
8484
* @throws BigQueryHelperException if {@code keyStream} is not a valid JSON key stream
8585
*/
8686
public static RemoteBigQueryHelper create(String projectId, InputStream keyStream)

gcloud-java-bigquery/src/test/java/com/google/gcloud/bigquery/ITBigQueryTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
package com.google.gcloud.bigquery;
1818

19+
import static org.junit.Assert.assertEquals;
1920
import static org.junit.Assert.assertFalse;
2021
import static org.junit.Assert.assertNotNull;
21-
import static org.junit.Assert.assertEquals;
2222
import static org.junit.Assert.assertNull;
2323
import static org.junit.Assert.assertTrue;
2424

@@ -302,8 +302,8 @@ public void testCreateExternalTable() throws InterruptedException {
302302
assertEquals(createdTableInfo.tableId(), remoteTableInfo.tableId());
303303
assertEquals(TABLE_SCHEMA, remoteTableInfo.schema());
304304
QueryRequest request = QueryRequest.builder(
305-
"SELECT TimestampField, StringField, IntegerField, BooleanField FROM " + DATASET + "." +
306-
tableName)
305+
"SELECT TimestampField, StringField, IntegerField, BooleanField FROM " + DATASET + "."
306+
+ tableName)
307307
.defaultDataset(DatasetId.of(DATASET))
308308
.maxWaitTime(60000L)
309309
.maxResults(1000L)

gcloud-java-core/src/main/java/com/google/gcloud/AuthCredentials.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,8 @@ public static AuthCredentials createForAppEngine() {
258258
* variable GOOGLE_APPLICATION_CREDENTIALS.
259259
* </p>
260260
*
261-
* @return the credentials instance.
262-
* @throws IOException if the credentials cannot be created in the current environment.
261+
* @return the credentials instance
262+
* @throws IOException if the credentials cannot be created in the current environment
263263
*/
264264
public static AuthCredentials createApplicationDefaults() throws IOException {
265265
return new ApplicationDefaultAuthCredentials();
@@ -275,7 +275,7 @@ public static AuthCredentials createApplicationDefaults() throws IOException {
275275
*
276276
* @param account id of the Service Account
277277
* @param privateKey private key associated to the account
278-
* @return the credentials instance.
278+
* @return the credentials instance
279279
*/
280280
public static ServiceAccountAuthCredentials createFor(String account, PrivateKey privateKey) {
281281
return new ServiceAccountAuthCredentials(account, privateKey);
@@ -290,8 +290,8 @@ public static ServiceAccountAuthCredentials createFor(String account, PrivateKey
290290
* </p>
291291
*
292292
* @param jsonCredentialStream stream for Service Account Credentials in JSON format
293-
* @return the credentials instance.
294-
* @throws IOException if the credentials cannot be created from the stream.
293+
* @return the credentials instance
294+
* @throws IOException if the credentials cannot be created from the stream
295295
*/
296296
public static ServiceAccountAuthCredentials createForJson(InputStream jsonCredentialStream)
297297
throws IOException {

gcloud-java-core/src/main/java/com/google/gcloud/BaseService.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
/**
2020
* Base class for service objects.
2121
*
22-
* @param <OptionsT> the {@code ServiceOptions} subclass corresponding to the service.
22+
* @param <OptionsT> the {@code ServiceOptions} subclass corresponding to the service
2323
*/
2424
public abstract class BaseService<OptionsT extends ServiceOptions<?, ?, OptionsT>>
2525
implements Service<OptionsT> {

gcloud-java-core/src/main/java/com/google/gcloud/ExceptionHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ enum RetryResult {
6464
* This method is called after the evaluation and could alter its result.
6565
*
6666
* @param exception the exception that is being evaluated
67-
* @param retryResult the result of the evaluation so far.
67+
* @param retryResult the result of the evaluation so far
6868
* @return {@link RetryResult} to indicate if the exception should be ignored (
6969
* {@link RetryResult#RETRY}), propagated ({@link RetryResult#NO_RETRY}), or evaluation
7070
* should proceed ({@link RetryResult#CONTINUE_EVALUATION}).
@@ -250,7 +250,7 @@ boolean shouldRetry(Exception ex) {
250250
Interceptor.RetryResult retryResult =
251251
retryInfo == null ? Interceptor.RetryResult.NO_RETRY : retryInfo.retry;
252252
for (Interceptor interceptor : interceptors) {
253-
Interceptor.RetryResult interceptorRetry =
253+
Interceptor.RetryResult interceptorRetry =
254254
checkNotNull(interceptor.afterEval(ex, retryResult));
255255
if (interceptorRetry != Interceptor.RetryResult.CONTINUE_EVALUATION) {
256256
retryResult = interceptorRetry;

gcloud-java-core/src/main/java/com/google/gcloud/Page.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
* page = page.nextPage();
4242
* }}</pre>
4343
*
44-
* @param <T> the value type that the page holds.
44+
* @param <T> the value type that the page holds
4545
*/
4646
public interface Page<T> {
4747

0 commit comments

Comments
 (0)