Package com.linecorp.centraldogma.client

Class PreviewDiffRequest

java.lang.Object

com.linecorp.centraldogma.client.PreviewDiffRequest

public final class PreviewDiffRequest
extends Object

Prepares to send a CentralDogma.getPreviewDiffs(String, String, Revision, Iterable) request to the Central Dogma repository.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<List<Change<?>>>	get()	Retrieves the preview diffs, which are hypothetical diffs generated from the Revision.HEAD and the latest Revision if the Changes were successfully pushed to the specified repository.
CompletableFuture<List<Change<?>>>	get(Revision baseRevision)	Retrieves the preview diffs, which are hypothetical diffs generated from the specified Revision and the latest Revision if the Changes were successfully pushed to the specified repository.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

public CompletableFuture<List<Change<?>>> get()

Retrieves the preview diffs, which are hypothetical diffs generated from the Revision.HEAD and the latest Revision if the Changes were successfully pushed to the specified repository. This operation is useful for pre-checking if the Changes will be applied as expected without any conflicts.

Returns:

the diffs which would be committed if the Changes were pushed successfully

get

public CompletableFuture<List<Change<?>>> get(Revision baseRevision)

Retrieves the preview diffs, which are hypothetical diffs generated from the specified Revision and the latest Revision if the Changes were successfully pushed to the specified repository. This operation is useful for pre-checking if the Changes will be applied as expected without any conflicts.

Returns:

the diffs which would be committed if the Changes were pushed successfully