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.Change;
23  import com.linecorp.centraldogma.common.Query;
24  import com.linecorp.centraldogma.common.Revision;
25  
26  /**
27   * Prepares to send a {@link CentralDogma#getDiff(String, String, Revision, Revision, Query)} request to the
28   * Central Dogma repository.
29   */
30  public final class DiffRequest<T> {
31  
32      private final CentralDogmaRepository centralDogmaRepo;
33      private final Query<T> query;
34  
35      DiffRequest(CentralDogmaRepository centralDogmaRepo, Query<T> query) {
36          this.centralDogmaRepo = centralDogmaRepo;
37          this.query = query;
38      }
39  
40      /**
41       * Queries a file at two different revisions and returns the diff of the two {@link Query} results.
42       *
43       * @return the {@link Change} that contains the diff of the file matched by the given {@code query}
44       *         between the specified two revisions
45       */
46      public CompletableFuture<Change<T>> get(Revision from, Revision to) {
47          requireNonNull(from, "from");
48          requireNonNull(to, "to");
49          return centralDogmaRepo.centralDogma().getDiff(centralDogmaRepo.projectName(),
50                                                         centralDogmaRepo.repositoryName(),
51                                                         from, to, query);
52      }
53  }