/
TransactionOptions.java
92 lines (80 loc) · 2.87 KB
/
TransactionOptions.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
* Copyright 2017 Google LLC
*
* 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 the License.
*/
package com.google.cloud.firestore;
import com.google.common.base.Preconditions;
import java.util.concurrent.Executor;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/** Options specifying the behavior of Firestore Transactions. */
public final class TransactionOptions {
private static final int DEFAULT_NUM_ATTEMPTS = 5;
private final int numberOfAttempts;
private final Executor executor;
TransactionOptions(int maxAttempts, Executor executor) {
this.numberOfAttempts = maxAttempts;
this.executor = executor;
}
public int getNumberOfAttempts() {
return numberOfAttempts;
}
@Nullable
public Executor getExecutor() {
return executor;
}
/**
* Create a default set of options suitable for most use cases. Transactions will be attempted 5
* times.
*
* @return The TransactionOptions object.
*/
@Nonnull
public static TransactionOptions create() {
return new TransactionOptions(DEFAULT_NUM_ATTEMPTS, null);
}
/**
* Create a default set of options with a custom number of retry attempts.
*
* @param numberOfAttempts The number of execution attempts.
* @return The TransactionOptions object.
*/
@Nonnull
public static TransactionOptions create(int numberOfAttempts) {
Preconditions.checkArgument(numberOfAttempts > 0, "You must allow at least one attempt");
return new TransactionOptions(numberOfAttempts, null);
}
/**
* Create a default set of options with a custom executor.
*
* @param executor The executor to run the user callback code on.
* @return The TransactionOptions object.
*/
@Nonnull
public static TransactionOptions create(@Nonnull Executor executor) {
return new TransactionOptions(DEFAULT_NUM_ATTEMPTS, executor);
}
/**
* Create a default set of options with a custom executor and a custom number of retry attempts.
*
* @param executor The executor to run the user callback code on.
* @param numberOfAttempts The number of execution attempts.
* @return The TransactionOptions object.
*/
@Nonnull
public static TransactionOptions create(@Nonnull Executor executor, int numberOfAttempts) {
Preconditions.checkArgument(numberOfAttempts > 0, "You must allow at least one attempt");
return new TransactionOptions(numberOfAttempts, executor);
}
}