1 /*
2 * Copyright 2021 LINE Corporation
3 *
4 * LINE Corporation licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package com.linecorp.centraldogma.client;
17
18 import static java.util.Objects.requireNonNull;
19
20 import java.util.concurrent.CompletableFuture;
21
22 import com.linecorp.centraldogma.common.Entry;
23 import com.linecorp.centraldogma.common.Query;
24 import com.linecorp.centraldogma.common.Revision;
25
26 /**
27 * Prepares to send a {@link CentralDogma#getFile(String, String, Revision, Query)} request to the
28 * Central Dogma repository.
29 */
30 public final class FileRequest<T> {
31
32 private final Query<T> query;
33 private final CentralDogmaRepository centralDogmaRepo;
34
35 FileRequest(CentralDogmaRepository centralDogmaRepo, Query<T> query) {
36 this.query = query;
37 this.centralDogmaRepo = centralDogmaRepo;
38 }
39
40 /**
41 * Retrieves a file located at {@link Query#path()} at the {@link Revision#HEAD}.
42 *
43 * @return the {@link Entry} that is matched by the given {@link Query}
44 */
45 public CompletableFuture<Entry<T>> get() {
46 return get(Revision.HEAD);
47 }
48
49 /**
50 * Retrieves a file located at {@link Query#path()} at the {@link Revision}.
51 *
52 * @return the {@link Entry} that is matched by the given {@link Query}
53 */
54 public CompletableFuture<Entry<T>> get(Revision revision) {
55 requireNonNull(revision, "revision");
56 return centralDogmaRepo.centralDogma().getFile(centralDogmaRepo.projectName(),
57 centralDogmaRepo.repositoryName(),
58 revision, query);
59 }
60 }