Skip to content

Commit 41d43e8

Browse files
kolea2kolea2
authored
refactor: rename internal class QueryAndReadOptions to QueryConfig (googleapis#1245)
1 parent f087f31 commit 41d43e8

File tree

5 files changed

+31
-45
lines changed

5 files changed

+31
-45
lines changed

‎google-cloud-datastore/clirr-ignored-differences.xml

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,16 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!-- see http://mojo.codehaus.org/clirr-maven-plugin/examples/ignored-differences.html -->
33
<differences>
4+
<!-- renaming internal only class-->
45
<difference>
5-
<className>com/google/cloud/datastore/Datastore</className>
6-
<method>java.util.List reserveIds(com.google.cloud.datastore.Key[])</method>
7-
<differenceType>7012</differenceType>
6+
<className>com/google/cloud/datastore/ReadOption$QueryAndReadOptions</className>
7+
<method>*</method>
8+
<differenceType>8001</differenceType>
89
</difference>
910
<difference>
10-
<className>com/google/cloud/datastore/spi/v1/DatastoreRpc</className>
11-
<method>com.google.datastore.v1.ReserveIdsResponse reserveIds(com.google.datastore.v1.ReserveIdsRequest)</method>
12-
<differenceType>7012</differenceType>
13-
</difference>
14-
<difference>
15-
<className>com/google/cloud/datastore/spi/v1/DatastoreRpc</className>
16-
<method>com.google.datastore.v1.RunAggregationQueryResponse runAggregationQuery(com.google.datastore.v1.RunAggregationQueryRequest)</method>
17-
<differenceType>7012</differenceType>
18-
</difference>
19-
<difference>
20-
<className>com/google/cloud/datastore/Datastore</className>
21-
<method>com.google.cloud.datastore.AggregationResults runAggregation(com.google.cloud.datastore.AggregationQuery, com.google.cloud.datastore.ReadOption[])</method>
22-
<differenceType>7012</differenceType>
23-
</difference>
24-
<difference>
25-
<className>com/google/cloud/datastore/DatastoreReader</className>
26-
<method>com.google.cloud.datastore.AggregationResults runAggregation(com.google.cloud.datastore.AggregationQuery)</method>
27-
<differenceType>7012</differenceType>
11+
<className>com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparer</className>
12+
<method>*QueryAndReadOptions*</method>
13+
<to>*QueryConfig*</to>
14+
<differenceType>7005</differenceType>
2815
</difference>
2916
</differences>

‎google-cloud-datastore/src/main/java/com/google/cloud/datastore/ReadOption.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -142,17 +142,17 @@ static Map<Class<? extends ReadOption>, ReadOption> asImmutableMap(List<ReadOpti
142142
}
143143

144144
@InternalApi
145-
public static class QueryAndReadOptions<Q extends Query<?>> {
145+
public static class QueryConfig<Q extends Query<?>> {
146146

147147
Q query;
148148
List<ReadOption> readOptions;
149149

150-
private QueryAndReadOptions(Q query, List<ReadOption> readOptions) {
150+
private QueryConfig(Q query, List<ReadOption> readOptions) {
151151
this.query = query;
152152
this.readOptions = readOptions;
153153
}
154154

155-
private QueryAndReadOptions(Q query) {
155+
private QueryConfig(Q query) {
156156
this.query = query;
157157
this.readOptions = Collections.emptyList();
158158
}
@@ -165,13 +165,13 @@ public List<ReadOption> getReadOptions() {
165165
return readOptions;
166166
}
167167

168-
public static <Q extends Query<?>> QueryAndReadOptions<Q> create(Q query) {
169-
return new QueryAndReadOptions<>(query);
168+
public static <Q extends Query<?>> QueryConfig<Q> create(Q query) {
169+
return new QueryConfig<>(query);
170170
}
171171

172-
public static <Q extends Query<?>> QueryAndReadOptions<Q> create(
172+
public static <Q extends Query<?>> QueryConfig<Q> create(
173173
Q query, List<ReadOption> readOptions) {
174-
return new QueryAndReadOptions<>(query, readOptions);
174+
return new QueryConfig<>(query, readOptions);
175175
}
176176
}
177177
}

‎google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/AggregationQueryExecutor.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import com.google.cloud.datastore.AggregationResults;
2121
import com.google.cloud.datastore.DatastoreOptions;
2222
import com.google.cloud.datastore.ReadOption;
23-
import com.google.cloud.datastore.ReadOption.QueryAndReadOptions;
23+
import com.google.cloud.datastore.ReadOption.QueryConfig;
2424
import com.google.cloud.datastore.execution.request.AggregationQueryRequestProtoPreparer;
2525
import com.google.cloud.datastore.execution.response.AggregationQueryResponseTransformer;
2626
import com.google.cloud.datastore.spi.v1.DatastoreRpc;
@@ -57,10 +57,10 @@ public AggregationResults execute(AggregationQuery query, ReadOption... readOpti
5757

5858
private RunAggregationQueryRequest getRunAggregationQueryRequest(
5959
AggregationQuery query, ReadOption... readOptions) {
60-
QueryAndReadOptions<AggregationQuery> queryAndReadOptions =
60+
QueryConfig<AggregationQuery> queryConfig =
6161
readOptions == null
62-
? QueryAndReadOptions.create(query)
63-
: QueryAndReadOptions.create(query, Arrays.asList(readOptions));
64-
return this.protoPreparer.prepare(queryAndReadOptions);
62+
? QueryConfig.create(query)
63+
: QueryConfig.create(query, Arrays.asList(readOptions));
64+
return this.protoPreparer.prepare(queryConfig);
6565
}
6666
}

‎google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparer.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import com.google.cloud.datastore.DatastoreOptions;
2323
import com.google.cloud.datastore.GqlQueryProtoPreparer;
2424
import com.google.cloud.datastore.ReadOption;
25-
import com.google.cloud.datastore.ReadOption.QueryAndReadOptions;
25+
import com.google.cloud.datastore.ReadOption.QueryConfig;
2626
import com.google.cloud.datastore.ReadOptionProtoPreparer;
2727
import com.google.cloud.datastore.StructuredQueryProtoPreparer;
2828
import com.google.cloud.datastore.aggregation.Aggregation;
@@ -37,7 +37,7 @@
3737

3838
@InternalApi
3939
public class AggregationQueryRequestProtoPreparer
40-
implements ProtoPreparer<QueryAndReadOptions<AggregationQuery>, RunAggregationQueryRequest> {
40+
implements ProtoPreparer<QueryConfig<AggregationQuery>, RunAggregationQueryRequest> {
4141

4242
private final DatastoreOptions datastoreOptions;
4343
private final StructuredQueryProtoPreparer structuredQueryProtoPreparer;
@@ -52,10 +52,9 @@ public AggregationQueryRequestProtoPreparer(DatastoreOptions datastoreOptions) {
5252
}
5353

5454
@Override
55-
public RunAggregationQueryRequest prepare(
56-
QueryAndReadOptions<AggregationQuery> aggregationQueryAndReadOptions) {
57-
AggregationQuery aggregationQuery = aggregationQueryAndReadOptions.getQuery();
58-
List<ReadOption> readOptions = aggregationQueryAndReadOptions.getReadOptions();
55+
public RunAggregationQueryRequest prepare(QueryConfig<AggregationQuery> queryConfig) {
56+
AggregationQuery aggregationQuery = queryConfig.getQuery();
57+
List<ReadOption> readOptions = queryConfig.getReadOptions();
5958
PartitionId partitionId = getPartitionId(aggregationQuery);
6059
RunAggregationQueryRequest.Builder aggregationQueryRequestBuilder =
6160
RunAggregationQueryRequest.newBuilder()

‎google-cloud-datastore/src/test/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparerTest.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
import com.google.cloud.datastore.GqlQuery;
3939
import com.google.cloud.datastore.Query;
4040
import com.google.cloud.datastore.ReadOption;
41-
import com.google.cloud.datastore.ReadOption.QueryAndReadOptions;
41+
import com.google.cloud.datastore.ReadOption.QueryConfig;
4242
import com.google.common.collect.ImmutableMap;
4343
import com.google.datastore.v1.RunAggregationQueryRequest;
4444
import java.util.HashMap;
@@ -91,7 +91,7 @@ public class AggregationQueryRequestProtoPreparerTest {
9191
@Test
9292
public void shouldPrepareAggregationQueryRequestWithGivenStructuredQuery() {
9393
RunAggregationQueryRequest runAggregationQueryRequest =
94-
protoPreparer.prepare(QueryAndReadOptions.create(AGGREGATION_OVER_STRUCTURED_QUERY));
94+
protoPreparer.prepare(QueryConfig.create(AGGREGATION_OVER_STRUCTURED_QUERY));
9595

9696
assertThat(runAggregationQueryRequest.getProjectId()).isEqualTo(PROJECT_ID);
9797
assertThat(runAggregationQueryRequest.getDatabaseId()).isEqualTo(DATABASE_ID);
@@ -114,7 +114,7 @@ public void shouldPrepareAggregationQueryRequestWithGivenStructuredQuery() {
114114
@Test
115115
public void shouldPrepareAggregationQueryRequestWithGivenGqlQuery() {
116116
RunAggregationQueryRequest runAggregationQueryRequest =
117-
protoPreparer.prepare(QueryAndReadOptions.create(AGGREGATION_OVER_GQL_QUERY));
117+
protoPreparer.prepare(QueryConfig.create(AGGREGATION_OVER_GQL_QUERY));
118118

119119
assertThat(runAggregationQueryRequest.getProjectId()).isEqualTo(PROJECT_ID);
120120
assertThat(runAggregationQueryRequest.getDatabaseId()).isEqualTo(DATABASE_ID);
@@ -172,9 +172,9 @@ public void shouldPrepareAggregationQueryWithNamespaceFromDatastoreOptions() {
172172
Query.newAggregationQueryBuilder().over(COMPLETED_TASK_GQL_QUERY).build();
173173

174174
RunAggregationQueryRequest runAggregationQueryFromStructuredQuery =
175-
protoPreparer.prepare(QueryAndReadOptions.create(structuredQueryWithoutNamespace));
175+
protoPreparer.prepare(QueryConfig.create(structuredQueryWithoutNamespace));
176176
RunAggregationQueryRequest runAggregationQueryFromGqlQuery =
177-
protoPreparer.prepare(QueryAndReadOptions.create(gqlQueryWithoutNamespace));
177+
protoPreparer.prepare(QueryConfig.create(gqlQueryWithoutNamespace));
178178

179179
assertThat(runAggregationQueryFromStructuredQuery.getPartitionId().getNamespaceId())
180180
.isEqualTo(NAMESPACE);
@@ -183,6 +183,6 @@ public void shouldPrepareAggregationQueryWithNamespaceFromDatastoreOptions() {
183183
}
184184

185185
private RunAggregationQueryRequest prepareQuery(AggregationQuery query, ReadOption readOption) {
186-
return protoPreparer.prepare(QueryAndReadOptions.create(query, singletonList(readOption)));
186+
return protoPreparer.prepare(QueryConfig.create(query, singletonList(readOption)));
187187
}
188188
}

0 commit comments

Comments
 (0)