Skip to content

Commit d1765c7

Browse files
author
Ajay Kannan
committed
Fix indentation issues in javadoc code samples
1 parent 307ddf3 commit d1765c7

10 files changed

Lines changed: 69 additions & 69 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ public Builder addRow(RowToInsert rowToInsert) {
177177
* Adds a row to be inserted with associated id.
178178
*
179179
* <p>Example usage of adding a row with associated id:
180-
* <pre> {@code
180+
* <pre> {@code
181181
* InsertAllRequest.Builder builder = InsertAllRequest.builder(tableId);
182182
* List<Long> repeatedFieldValue = Arrays.asList(1L, 2L);
183183
* Map<String, Object> recordContent = new HashMap<String, Object>();
@@ -198,7 +198,7 @@ public Builder addRow(String id, Map<String, Object> content) {
198198
* Adds a row to be inserted without an associated id.
199199
*
200200
* <p>Example usage of adding a row without an associated id:
201-
* <pre> {@code
201+
* <pre> {@code
202202
* InsertAllRequest.Builder builder = InsertAllRequest.builder(tableId);
203203
* List<Long> repeatedFieldValue = Arrays.asList(1L, 2L);
204204
* Map<String, Object> recordContent = new HashMap<String, Object>();

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* {@link QueryResponse#jobCompleted()} returns {@code true}.
3636
*
3737
* <p>Example usage of a query request:
38-
* <pre> {@code
38+
* <pre> {@code
3939
* // Substitute "field", "table" and "dataset" with real field, table and dataset identifiers
4040
* QueryRequest request = QueryRequest.builder("SELECT field FROM table")
4141
* .defaultDataset(DatasetId.of("dataset"))

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* Query Request ({@link BigQuery#query(QueryRequest)}).
3030
*
3131
* <p>Example usage of a query response:
32-
* <pre> {@code
32+
* <pre> {@code
3333
* QueryResponse response = bigquery.query(request);
3434
* while (!response.jobCompleted()) {
3535
* Thread.sleep(1000);

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@
2121
*
2222
* <p>
2323
* A typical capture usage:
24-
* <pre> {@code
24+
* <pre> {@code
2525
* X restorableObj; // X instanceof Restorable<X>
2626
* RestorableState<X> state = restorableObj.capture();
2727
* .. persist state
2828
* }</pre>
2929
*
3030
* A typical restore usage:
31-
* <pre> {@code
31+
* <pre> {@code
3232
* RestorableState<X> state = ... // read from persistence
3333
* X restorableObj = state.restore();
3434
* ...

gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/Batch.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@
2424
* to the Datastore upon {@link #submit}.
2525
* A usage example:
2626
* <pre> {@code
27-
* Entity entity1 = datastore.get(key1);
28-
* Batch batch = datastore.newBatch();
29-
* Entity entity2 = Entity.builder(key2).set("name", "John").build();
30-
* entity1 = Entity.builder(entity1).clear().setNull("bla").build();
31-
* Entity entity3 = Entity.builder(key3).set("title", "title").build();
32-
* batch.update(entity1);
33-
* batch.add(entity2, entity3);
34-
* batch.submit();
27+
* Entity entity1 = datastore.get(key1);
28+
* Batch batch = datastore.newBatch();
29+
* Entity entity2 = Entity.builder(key2).set("name", "John").build();
30+
* entity1 = Entity.builder(entity1).clear().setNull("bla").build();
31+
* Entity entity3 = Entity.builder(key3).set("title", "title").build();
32+
* batch.update(entity1);
33+
* batch.add(entity2, entity3);
34+
* batch.submit();
3535
* } </pre>
3636
*/
3737
public interface Batch extends DatastoreBatchWriter {

gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/GqlQuery.java

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,27 @@
4343
* <h3>A usage example:</h3>
4444
*
4545
* <p>When the type of the results is known the preferred usage would be:
46-
* <pre>{@code
47-
* Query<Entity> query =
48-
* Query.gqlQueryBuilder(Query.ResultType.ENTITY, "select * from kind").build();
49-
* QueryResults<Entity> results = datastore.run(query);
50-
* while (results.hasNext()) {
51-
* Entity entity = results.next();
52-
* ...
53-
* }
46+
* <pre> {@code
47+
* Query<Entity> query =
48+
* Query.gqlQueryBuilder(Query.ResultType.ENTITY, "select * from kind").build();
49+
* QueryResults<Entity> results = datastore.run(query);
50+
* while (results.hasNext()) {
51+
* Entity entity = results.next();
52+
* ...
53+
* }
5454
* } </pre>
5555
*
5656
* <p>When the type of the results is unknown you can use this approach:
57-
* <pre>{@code
58-
* Query<?> query = Query.gqlQueryBuilder("select __key__ from kind").build();
59-
* QueryResults<?> results = datastore.run(query);
60-
* if (Key.class.isAssignableFrom(results.resultClass())) {
61-
* QueryResults<Key> keys = (QueryResults<Key>) results;
62-
* while (keys.hasNext()) {
63-
* Key key = keys.next();
64-
* ...
65-
* }
57+
* <pre> {@code
58+
* Query<?> query = Query.gqlQueryBuilder("select __key__ from kind").build();
59+
* QueryResults<?> results = datastore.run(query);
60+
* if (Key.class.isAssignableFrom(results.resultClass())) {
61+
* QueryResults<Key> keys = (QueryResults<Key>) results;
62+
* while (keys.hasNext()) {
63+
* Key key = keys.next();
64+
* ...
6665
* }
66+
* }
6767
* } </pre>
6868
*
6969
* @param <V> the type of the result values this query will produce

gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/StructuredQuery.java

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -46,35 +46,35 @@
4646
* <h3>A usage example:</h3>
4747
*
4848
* <p>A simple query that returns all entities for a specific kind
49-
* <pre>{@code
50-
* Query<Entity> query = Query.entityQueryBuilder().kind(kind).build();
51-
* QueryResults<Entity> results = datastore.run(query);
52-
* while (results.hasNext()) {
53-
* Entity entity = results.next();
54-
* ...
55-
* }
49+
* <pre> {@code
50+
* Query<Entity> query = Query.entityQueryBuilder().kind(kind).build();
51+
* QueryResults<Entity> results = datastore.run(query);
52+
* while (results.hasNext()) {
53+
* Entity entity = results.next();
54+
* ...
55+
* }
5656
* } </pre>
5757
*
5858
* <p>A simple key-only query of all entities for a specific kind
59-
* <pre>{@code
60-
* Query<Key> keyOnlyQuery = Query.keyQueryBuilder().kind(KIND1).build();
61-
* QueryResults<Key> results = datastore.run(keyOnlyQuery);
62-
* ...
59+
* <pre> {@code
60+
* Query<Key> keyOnlyQuery = Query.keyQueryBuilder().kind(KIND1).build();
61+
* QueryResults<Key> results = datastore.run(keyOnlyQuery);
62+
* ...
6363
* } </pre>
6464
*
6565
* <p>A less trivial example of a projection query that returns the first 10 results
6666
* of "age" and "name" properties (sorted and grouped by "age") with an age greater than 18
67-
* <pre>{@code
68-
* Query<ProjectionEntity> query = Query.projectionEntityQueryBuilder()
69-
* .kind(kind)
70-
* .projection(Projection.property("age"), Projection.first("name"))
71-
* .filter(PropertyFilter.gt("age", 18))
72-
* .groupBy("age")
73-
* .orderBy(OrderBy.asc("age"))
74-
* .limit(10)
75-
* .build();
76-
* QueryResults<ProjectionEntity> results = datastore.run(query);
77-
* ...
67+
* <pre> {@code
68+
* Query<ProjectionEntity> query = Query.projectionEntityQueryBuilder()
69+
* .kind(kind)
70+
* .projection(Projection.property("age"), Projection.first("name"))
71+
* .filter(PropertyFilter.gt("age", 18))
72+
* .groupBy("age")
73+
* .orderBy(OrderBy.asc("age"))
74+
* .limit(10)
75+
* .build();
76+
* QueryResults<ProjectionEntity> results = datastore.run(query);
77+
* ...
7878
* } </pre>
7979
*
8080
* @param <V> the type of the result values this query will produce

gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/Transaction.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,21 @@
3030
* the Datastore upon {@code commit}.
3131
* A usage example:
3232
* <pre> {@code
33-
* Transaction transaction = datastore.newTransaction();
34-
* try {
35-
* Entity entity = transaction.get(key);
36-
* if (!entity.contains("last_name") || entity.isNull("last_name")) {
37-
* String[] name = entity.getString("name").split(" ");
38-
* entity = Entity.builder(entity).remove("name").set("first_name", name[0])
39-
* .set("last_name", name[1]).build();
40-
* transaction.update(entity);
41-
* transaction.commit();
42-
* }
43-
* } finally {
44-
* if (transaction.active()) {
45-
* transaction.rollback();
46-
* }
33+
* Transaction transaction = datastore.newTransaction();
34+
* try {
35+
* Entity entity = transaction.get(key);
36+
* if (!entity.contains("last_name") || entity.isNull("last_name")) {
37+
* String[] name = entity.getString("name").split(" ");
38+
* entity = Entity.builder(entity).remove("name").set("first_name", name[0])
39+
* .set("last_name", name[1]).build();
40+
* transaction.update(entity);
41+
* transaction.commit();
4742
* }
43+
* } finally {
44+
* if (transaction.active()) {
45+
* transaction.rollback();
46+
* }
47+
* }
4848
* } </pre>
4949
*
5050
* @see <a href="https://cloud.google.com/datastore/docs/concepts/transactions">

gcloud-java-storage/src/main/java/com/google/gcloud/storage/CopyWriter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public class CopyWriter implements Restorable<CopyWriter> {
5757
* is {@code false} will block until all pending chunks are copied.
5858
*
5959
* <p>This method has the same effect of doing:
60-
* <pre> {@code while (!copyWriter.isDone()) {
60+
* <pre> {@code while (!copyWriter.isDone()) {
6161
* copyWriter.copyChunk();
6262
* }}
6363
* </pre>

gcloud-java-storage/src/main/java/com/google/gcloud/storage/Storage.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1376,7 +1376,7 @@ private static void checkContentType(BlobInfo blobInfo) throws IllegalArgumentEx
13761376
* <pre> {@code BlobInfo blob = service.copy(copyRequest).result();}
13771377
* </pre>
13781378
* To explicitly issue chunk copy requests use {@link CopyWriter#copyChunk()} instead:
1379-
* <pre> {@code CopyWriter copyWriter = service.copy(copyRequest);
1379+
* <pre> {@code CopyWriter copyWriter = service.copy(copyRequest);
13801380
* while (!copyWriter.isDone()) {
13811381
* copyWriter.copyChunk();
13821382
* }

0 commit comments

Comments
 (0)