Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Marking Transaction, Batch and DatastoreBatchWriter class with 'NotThreadSafe' annotation #1082

Merged
merged 6 commits into from
May 26, 2023
Merged

docs: Marking Transaction, Batch and DatastoreBatchWriter class with 'NotThreadSafe' annotation #1082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2fe3a1e
doc: Marking Transaction, Batch and DatastoreBatchWriter class with @…
jainsahab May 24, 2023
4d36066
fix lint
jainsahab May 24, 2023
1cbd69e
adding jsr dependency explicitly
jainsahab May 24, 2023
d646d28
Empty commit
jainsahab May 24, 2023
fb6c899
fixing casing and punctuation.
jainsahab May 25, 2023
9500ecf
fix lint
jainsahab May 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions google-cloud-datastore/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@
<groupId>io.opencensus</groupId>
<artifactId>opencensus-api</artifactId>
</dependency>
<dependency>
<groupId>com.google.code.findbugs</groupId>
<artifactId>jsr305</artifactId>
</dependency>

<!-- Test dependencies -->
<dependency>
Expand Down
9 changes: 9 additions & 0 deletions google-cloud-datastore/src/main/java/com/google/cloud/datastore/Batch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package com.google.cloud.datastore;

import java.util.List;
import javax.annotation.concurrent.NotThreadSafe;

/**
* An interface to represent a batch of write operations. Any write operation that is applied on a
Expand All @@ -32,7 +33,15 @@
* batch.add(entity2, entity3);
* batch.submit();
* }</pre>
*
* <p><b> WARNING: This class maintains an internal state in terms of {@link
* java.util.LinkedHashMap} and {@link java.util.LinkedHashSet} which gets updated on every method
* call performing CRUD operations to record the mutations. Since {@link java.util.LinkedHashMap} is
* not thread safe as per its <a
* href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashMap.html">documentation</a>,
* This class too should not be treated as a thread safe class. </b>
*/
@NotThreadSafe
public interface Batch extends DatastoreBatchWriter {

interface Response {
Expand Down
9 changes: 9 additions & 0 deletions google-cloud-datastore/src/main/java/com/google/cloud/datastore/DatastoreBatchWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,20 @@
package com.google.cloud.datastore;

import java.util.List;
import javax.annotation.concurrent.NotThreadSafe;

/**
* An interface to represent a batch of write operations. All write operation for a batch writer
* will be applied to the Datastore in one RPC call.
*
* <p><b> WARNING: This class maintains an internal state in terms of {@link
* java.util.LinkedHashMap} and {@link java.util.LinkedHashSet} which gets updated on every method
* call performing CRUD operations to record the mutations. Since {@link java.util.LinkedHashMap} is
* not thread safe as per its <a
* href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashMap.html">documentation</a>,
* This class too should not be treated as a thread safe class. </b>
*/
@NotThreadSafe
public interface DatastoreBatchWriter extends DatastoreWriter {

/**
Expand Down
12 changes: 10 additions & 2 deletions google-cloud-datastore/src/main/java/com/google/cloud/datastore/Transaction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,15 @@
import com.google.protobuf.ByteString;
import java.util.Iterator;
import java.util.List;
import javax.annotation.concurrent.NotThreadSafe;

/**
* A Google cloud datastore transaction. Similar to {@link Batch} any write operation that is
* applied on a transaction will only be sent to the Datastore upon {@link #commit}. A call to
* {@link #rollback} will invalidate the transaction and discard the changes. Any read operation
* that is done by a transaction will be part of it and therefore a {@code commit} is guaranteed to
* fail if an entity was modified outside of the transaction after it was read. Write operation on
* this transaction will not be reflected by read operation (as the changes are only sent to the
* fail if an entity was modified outside the transaction after it was read. Write operation on this
* transaction will not be reflected by read operation (as the changes are only sent to the
* Datastore upon {@code commit}. A usage example:
*
* <pre>{@code
Expand All @@ -52,7 +53,14 @@
*
* @see <a href="https://cloud.google.com/datastore/docs/concepts/transactions">Google Cloud
* Datastore transactions</a>
* <p><b> WARNING: This class maintains an internal state in terms of {@link
* java.util.LinkedHashMap} and {@link java.util.LinkedHashSet} which gets updated on every
* method call performing CRUD operations to record the mutations. Since {@link
* java.util.LinkedHashMap} is not thread safe as per its <a
* href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashMap.html">documentation</a>,
* This class too should not be treated as a thread safe class. </b>
*/
@NotThreadSafe
public interface Transaction extends DatastoreBatchWriter, DatastoreReaderWriter {

interface Response {
Expand Down