Skip to content

Commit eebc6c6

Browse files
BenWhiteheadBenWhitehead
committed
chore: rename RangeSpec.limit -> RangeSpec.maxLength to be more clear it is the length of the range not an end offset
* MaxLimitRangeSpecFunction -> MaxLengthRangeSpecFunction * LinearExponentialRangeSpecFunction#initialRangeSize -> initialMaxLength * LinearExponentialRangeSpecFunction#rangeSizeScalar -> maxLengthScalar
1 parent 12507e2 commit eebc6c6

File tree

8 files changed

+130
-132
lines changed

8 files changed

+130
-132
lines changed

‎google-cloud-storage/src/main/java/com/google/cloud/storage/BaseObjectReadSessionStreamRead.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public final ReadRange makeReadRange() {
9797
long currentOffset = readOffset.get();
9898
ReadRange.Builder b = ReadRange.newBuilder().setReadId(readId()).setReadOffset(currentOffset);
9999
rangeSpec
100-
.limit()
100+
.maxLength()
101101
.ifPresent(
102102
length -> {
103103
long readSoFar = currentOffset - rangeSpec.begin();

‎google-cloud-storage/src/main/java/com/google/cloud/storage/LinearExponentialRangeSpecFunction.java‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -31,60 +31,60 @@
3131
public final class LinearExponentialRangeSpecFunction extends RangeSpecFunction {
3232

3333
static final LinearExponentialRangeSpecFunction INSTANCE =
34-
new LinearExponentialRangeSpecFunction(ByteSizeConstants._1KiB, 4.0d);
35-
private final long initialRangeSize;
36-
private final double rangeSizeScalar;
34+
new LinearExponentialRangeSpecFunction(ByteSizeConstants._2MiB, 4.0d);
35+
private final long initialMaxLength;
36+
private final double maxLengthScalar;
3737

38-
private LinearExponentialRangeSpecFunction(long initialRangeSize, double rangeSizeScalar) {
39-
this.initialRangeSize = initialRangeSize;
40-
this.rangeSizeScalar = rangeSizeScalar;
38+
private LinearExponentialRangeSpecFunction(long initialMaxLength, double maxLengthScalar) {
39+
this.initialMaxLength = initialMaxLength;
40+
this.maxLengthScalar = maxLengthScalar;
4141
}
4242

43-
public long getInitialRangeSize() {
44-
return initialRangeSize;
43+
public long getInitialMaxLength() {
44+
return initialMaxLength;
4545
}
4646

47-
public LinearExponentialRangeSpecFunction withMinRangeSize(long initialRangeSize) {
48-
checkArgument(initialRangeSize > 0, "initialRangeSize > 0 (%s > 0)", initialRangeSize);
49-
return new LinearExponentialRangeSpecFunction(initialRangeSize, rangeSizeScalar);
47+
public LinearExponentialRangeSpecFunction withInitialMaxLength(long initialMaxLength) {
48+
checkArgument(initialMaxLength > 0, "initialMaxLength > 0 (%s > 0)", initialMaxLength);
49+
return new LinearExponentialRangeSpecFunction(initialMaxLength, maxLengthScalar);
5050
}
5151

52-
public double getRangeSizeScalar() {
53-
return rangeSizeScalar;
52+
public double getMaxLengthScalar() {
53+
return maxLengthScalar;
5454
}
5555

56-
public LinearExponentialRangeSpecFunction withRangeSizeScalar(double rangeSizeScalar) {
57-
checkArgument(rangeSizeScalar >= 1.0, "rangeSizeScalar >= 1.0 (%s >= 1.0)", rangeSizeScalar);
58-
return new LinearExponentialRangeSpecFunction(initialRangeSize, rangeSizeScalar);
56+
public LinearExponentialRangeSpecFunction withMaxLengthScalar(double maxLengthScalar) {
57+
checkArgument(maxLengthScalar >= 1.0, "maxLengthScalar >= 1.0 (%s >= 1.0)", maxLengthScalar);
58+
return new LinearExponentialRangeSpecFunction(initialMaxLength, maxLengthScalar);
5959
}
6060

6161
@Override
6262
public RangeSpec apply(long offset, RangeSpec prev) {
6363
if (prev == null) {
64-
return RangeSpec.of(offset, initialRangeSize);
64+
return RangeSpec.of(offset, initialMaxLength);
6565
}
6666

67-
OptionalLong maybeLimit = prev.limit();
68-
long limit;
69-
if (maybeLimit.isPresent()) {
70-
limit = maybeLimit.getAsLong();
67+
OptionalLong maybeMaxLength = prev.maxLength();
68+
long maxLength;
69+
if (maybeMaxLength.isPresent()) {
70+
maxLength = maybeMaxLength.getAsLong();
7171

72-
long expectedOffset = prev.begin() + limit;
72+
long expectedOffset = prev.begin() + maxLength;
7373
if (offset != expectedOffset) {
74-
return RangeSpec.of(offset, initialRangeSize);
74+
return RangeSpec.of(offset, initialMaxLength);
7575
}
7676

7777
} else {
78-
limit = Long.MAX_VALUE;
78+
maxLength = Long.MAX_VALUE;
7979
}
8080

81-
long scaleReadSize = scaleReadSize(limit, rangeSizeScalar);
81+
long scaleReadSize = scaleMaxLength(maxLength, maxLengthScalar);
8282

8383
return RangeSpec.of(offset, scaleReadSize);
8484
}
8585

86-
private static long scaleReadSize(long lastReadSize, double rangeSizeScalar) {
87-
double scaled = lastReadSize * rangeSizeScalar;
86+
private static long scaleMaxLength(long lastReadSize, double rangeMaxLengthScalar) {
87+
double scaled = lastReadSize * rangeMaxLengthScalar;
8888
if (Double.isInfinite(scaled)) {
8989
return Long.MAX_VALUE;
9090
}
@@ -100,20 +100,20 @@ public boolean equals(Object o) {
100100
return false;
101101
}
102102
LinearExponentialRangeSpecFunction that = (LinearExponentialRangeSpecFunction) o;
103-
return initialRangeSize == that.initialRangeSize
104-
&& Double.compare(rangeSizeScalar, that.rangeSizeScalar) == 0;
103+
return initialMaxLength == that.initialMaxLength
104+
&& Double.compare(maxLengthScalar, that.maxLengthScalar) == 0;
105105
}
106106

107107
@Override
108108
public int hashCode() {
109-
return Objects.hash(initialRangeSize, rangeSizeScalar);
109+
return Objects.hash(initialMaxLength, maxLengthScalar);
110110
}
111111

112112
@Override
113113
public String toString() {
114114
return MoreObjects.toStringHelper(this)
115-
.add("minRangeSize", initialRangeSize)
116-
.add("rangeSizeScalar", rangeSizeScalar)
115+
.add("initialMaxLength", initialMaxLength)
116+
.add("rangeMaxLengthScalar", maxLengthScalar)
117117
.toString();
118118
}
119119
}

google-cloud-storage/src/main/java/com/google/cloud/storage/MaxLimitRangeSpecFunction.java renamed to google-cloud-storage/src/main/java/com/google/cloud/storage/MaxLengthRangeSpecFunction.java

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,51 +24,51 @@
2424
import org.checkerframework.checker.nullness.qual.Nullable;
2525

2626
@BetaApi
27-
public final class MaxLimitRangeSpecFunction extends RangeSpecFunction {
28-
static final MaxLimitRangeSpecFunction INSTANCE = new MaxLimitRangeSpecFunction(0);
29-
private final long maxLimit;
27+
public final class MaxLengthRangeSpecFunction extends RangeSpecFunction {
28+
static final MaxLengthRangeSpecFunction INSTANCE = new MaxLengthRangeSpecFunction(0);
29+
private final long maxLength;
3030

31-
MaxLimitRangeSpecFunction(long maxLimit) {
32-
this.maxLimit = maxLimit;
31+
MaxLengthRangeSpecFunction(long maxLength) {
32+
this.maxLength = maxLength;
3333
}
3434

35-
public long getMaxLimit() {
36-
return maxLimit;
35+
public long getMaxLength() {
36+
return maxLength;
3737
}
3838

39-
public MaxLimitRangeSpecFunction withMaxLimit(long maxLimit) {
40-
checkArgument(maxLimit >= 0, "maxLimit >= 0 (%s >= 0)", maxLimit);
41-
return new MaxLimitRangeSpecFunction(maxLimit);
39+
public MaxLengthRangeSpecFunction withMaxLength(long maxLength) {
40+
checkArgument(maxLength >= 0, "maxLength >= 0 (%s >= 0)", maxLength);
41+
return new MaxLengthRangeSpecFunction(maxLength);
4242
}
4343

4444
@Override
4545
public RangeSpec apply(long offset, @Nullable RangeSpec prev) {
46-
if (prev == null || !prev.limit().isPresent()) {
47-
return RangeSpec.of(offset, maxLimit);
46+
if (prev == null || !prev.maxLength().isPresent()) {
47+
return RangeSpec.of(offset, maxLength);
4848
}
49-
long limit = prev.limit().getAsLong();
50-
return RangeSpec.of(offset, Math.min(limit, maxLimit));
49+
long limit = prev.maxLength().getAsLong();
50+
return RangeSpec.of(offset, Math.min(limit, maxLength));
5151
}
5252

5353
@Override
5454
public boolean equals(Object o) {
5555
if (this == o) {
5656
return true;
5757
}
58-
if (!(o instanceof MaxLimitRangeSpecFunction)) {
58+
if (!(o instanceof MaxLengthRangeSpecFunction)) {
5959
return false;
6060
}
61-
MaxLimitRangeSpecFunction that = (MaxLimitRangeSpecFunction) o;
62-
return maxLimit == that.maxLimit;
61+
MaxLengthRangeSpecFunction that = (MaxLengthRangeSpecFunction) o;
62+
return maxLength == that.maxLength;
6363
}
6464

6565
@Override
6666
public int hashCode() {
67-
return Objects.hashCode(maxLimit);
67+
return Objects.hashCode(maxLength);
6868
}
6969

7070
@Override
7171
public String toString() {
72-
return MoreObjects.toStringHelper(this).add("maxLimit", maxLimit).toString();
72+
return MoreObjects.toStringHelper(this).add("maxLength", maxLength).toString();
7373
}
7474
}

‎google-cloud-storage/src/main/java/com/google/cloud/storage/RangeSpec.java‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.annotation.concurrent.Immutable;
2626
import org.checkerframework.checker.nullness.qual.NonNull;
2727

28-
/** Defines a range with begin offset and limit. */
28+
/** Defines a range with a begin offset and optional maximum length. */
2929
@BetaApi
3030
@Immutable
3131
public abstract class RangeSpec {
@@ -37,20 +37,20 @@ private RangeSpec() {}
3737
public abstract long begin();
3838

3939
/**
40-
* A limit of the range if defined.
40+
* The max length of the range if defined.
4141
*
42-
* @see RangeSpecWithLimit
42+
* @see RangeSpecWithMaxLength
4343
*/
4444
@BetaApi
45-
public abstract OptionalLong limit();
45+
public abstract OptionalLong maxLength();
4646

4747
/**
48-
* Create a new instance of {@link RangeSpec} keeping {@code this.begin()} and with {@code limit}
49-
* as its new limit.
48+
* Create a new instance of {@link RangeSpec} keeping {@code this.begin()} and with {@code
49+
* maxLength} as its new maxLength.
5050
*/
5151
@NonNull
5252
@BetaApi
53-
public abstract RangeSpec withLimit(long limit);
53+
public abstract RangeSpec withMaxLength(long maxLength);
5454

5555
/** {@inheritDoc} */
5656
@Override
@@ -77,19 +77,19 @@ public static RangeSpec beginAt(long begin) {
7777
}
7878

7979
/**
80-
* Create a new RangeSpec with the provided {@code begin} and {@code limit}.
80+
* Create a new RangeSpec with the provided {@code begin} and {@code maxLength}.
8181
*
82-
* @throws IllegalArgumentException if begin is < 0, or if limit is < 0
82+
* @throws IllegalArgumentException if begin is < 0, or if maxLength is < 0
8383
*/
8484
@NonNull
8585
@BetaApi
86-
public static RangeSpec of(long begin, long limit) {
86+
public static RangeSpec of(long begin, long maxLength) {
8787
checkArgument(begin >= 0, "range being must be >= 0 (range begin = %s)", begin);
88-
checkArgument(limit >= 0, "range limit must be >= 0 (range limit = %s)", limit);
89-
if (limit == 0) {
88+
checkArgument(maxLength >= 0, "range maxLength must be >= 0 (range maxLength = %s)", maxLength);
89+
if (maxLength == 0) {
9090
return new RangeSpecWithoutLimit(begin);
9191
}
92-
return new RangeSpecWithLimit(begin, limit);
92+
return new RangeSpecWithMaxLength(begin, maxLength);
9393
}
9494

9595
/** A RangeSpec that represents to read from {@code 0} to {@code EOF} */
@@ -113,15 +113,15 @@ public long begin() {
113113
}
114114

115115
@Override
116-
public OptionalLong limit() {
116+
public OptionalLong maxLength() {
117117
return OptionalLong.empty();
118118
}
119119

120120
@Override
121121
@NonNull
122-
public RangeSpec withLimit(long limit) {
123-
checkArgument(limit >= 0, "range limit must be >= 0 (range limit = %s)", limit);
124-
return new RangeSpecWithLimit(begin, limit);
122+
public RangeSpec withMaxLength(long maxLength) {
123+
checkArgument(maxLength >= 0, "range maxLength must be >= 0 (range limit = %s)", maxLength);
124+
return new RangeSpecWithMaxLength(begin, maxLength);
125125
}
126126

127127
@Override
@@ -147,13 +147,13 @@ public String toString() {
147147
}
148148
}
149149

150-
static final class RangeSpecWithLimit extends RangeSpec {
150+
static final class RangeSpecWithMaxLength extends RangeSpec {
151151
private final long begin;
152-
private final long limit;
152+
private final long maxLength;
153153

154-
private RangeSpecWithLimit(long begin, long limit) {
154+
private RangeSpecWithMaxLength(long begin, long maxLength) {
155155
this.begin = begin;
156-
this.limit = limit;
156+
this.maxLength = maxLength;
157157
}
158158

159159
@Override
@@ -162,39 +162,39 @@ public long begin() {
162162
}
163163

164164
@Override
165-
public OptionalLong limit() {
166-
return OptionalLong.of(limit);
165+
public OptionalLong maxLength() {
166+
return OptionalLong.of(maxLength);
167167
}
168168

169169
@Override
170170
@NonNull
171-
public RangeSpec withLimit(long limit) {
172-
checkArgument(limit >= 0, "range limit must be >= 0 (range limit = %s)", limit);
173-
return new RangeSpecWithLimit(begin, limit);
171+
public RangeSpec withMaxLength(long maxLength) {
172+
checkArgument(maxLength >= 0, "range maxLength must be >= 0 (range limit = %s)", maxLength);
173+
return new RangeSpecWithMaxLength(begin, maxLength);
174174
}
175175

176176
@Override
177177
public boolean equals(Object o) {
178178
if (this == o) {
179179
return true;
180180
}
181-
if (!(o instanceof RangeSpecWithLimit)) {
181+
if (!(o instanceof RangeSpecWithMaxLength)) {
182182
return false;
183183
}
184-
RangeSpecWithLimit that = (RangeSpecWithLimit) o;
185-
return begin == that.begin && limit == that.limit;
184+
RangeSpecWithMaxLength that = (RangeSpecWithMaxLength) o;
185+
return begin == that.begin && maxLength == that.maxLength;
186186
}
187187

188188
@Override
189189
public int hashCode() {
190-
return Objects.hash(begin, limit);
190+
return Objects.hash(begin, maxLength);
191191
}
192192

193193
@Override
194194
public String toString() {
195195
return MoreObjects.toStringHelper(RangeSpec.class)
196196
.add("begin", begin)
197-
.add("limit", limit)
197+
.add("maxLength", maxLength)
198198
.toString();
199199
}
200200
}

‎google-cloud-storage/src/main/java/com/google/cloud/storage/RangeSpecFunction.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public static LinearExponentialRangeSpecFunction linearExponential() {
5353
}
5454

5555
@BetaApi
56-
public static MaxLimitRangeSpecFunction maxLimit(long maxLimit) {
57-
return MaxLimitRangeSpecFunction.INSTANCE.withMaxLimit(maxLimit);
56+
public static MaxLengthRangeSpecFunction maxLength(long maxLength) {
57+
return MaxLengthRangeSpecFunction.INSTANCE.withMaxLength(maxLength);
5858
}
5959
}

‎google-cloud-storage/src/main/java/com/google/cloud/storage/ReadProjectionConfigs.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616

1717
package com.google.cloud.storage;
1818

19-
2019
import com.google.api.core.BetaApi;
2120

2221
@BetaApi

‎google-cloud-storage/src/test/java/com/google/cloud/storage/ITObjectReadSessionTest.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
import com.google.api.core.ApiFuture;
2727
import com.google.api.core.ApiFutures;
2828
import com.google.cloud.storage.Crc32cValue.Crc32cLengthKnown;
29-
import com.google.cloud.storage.ReadProjectionConfigs.ReadAsSeekableChannel;
3029
import com.google.cloud.storage.Storage.BlobTargetOption;
3130
import com.google.cloud.storage.TransportCompatibility.Transport;
3231
import com.google.cloud.storage.ZeroCopySupport.DisposableByteString;
@@ -263,8 +262,8 @@ public void seekable() throws Exception {
263262
ReadProjectionConfigs.asSeekableChannel()
264263
.withRangeSpecFunction(
265264
RangeSpecFunction.linearExponential()
266-
.withMinRangeSize(_1MiB)
267-
.withRangeSizeScalar(4.0));
265+
.withInitialMaxLength(_1MiB)
266+
.withMaxLengthScalar(4.0));
268267

269268
BlobInfo gen1 = create(testContent);
270269
BlobId blobId = gen1.getBlobId();

0 commit comments

Comments
 (0)