Package com.linecorp.centraldogma.client

Class CentralDogmaRepository

java.lang.Object

com.linecorp.centraldogma.client.CentralDogmaRepository

public final class CentralDogmaRepository
extends Object

Prepares to send requests to the Central Dogma repository.

Method Summary

Modifier and Type	Method	Description
CommitRequest	commit(String summary, Change<?>... changes)	Returns a new CommitRequest that is used to push the Changes to the Central Dogma repository.
CommitRequest	commit(String summary, Iterable<? extends Change<?>> changes)	Returns a new CommitRequest that is used to push the Changes to the Central Dogma repository.
PreviewDiffRequest	diff(Change<?>... changes)	Returns a new PreviewDiffRequest that is used to retrieve the preview diff of files in the Central Dogma repository.
DiffFilesRequest	diff(PathPattern pathPattern)	Returns a new DiffFilesRequest that is used to retrieve the diff of files in the Central Dogma repository.
<T> DiffRequest<T>	diff(Query<T> query)	Returns a new DiffRequest that is used to retrieve the diff of the file in the Central Dogma repository.
PreviewDiffRequest	diff(Iterable<? extends Change<?>> changes)	Returns a new PreviewDiffRequest that is used to retrieve the preview diff of files in the Central Dogma repository.
DiffRequest<?>	diff(String path)	Returns a new DiffRequest that is used to retrieve the diff of the file in the Central Dogma repository.
boolean	equals(Object o)
FilesRequest	file(PathPattern pathPattern)	Returns a new FilesRequest that is used to retrieve or list files in the Central Dogma repository.
<T> FileRequest<T>	file(Query<T> query)	Returns a new FileRequest that is used to retrieve the file in the Central Dogma repository.
FileRequest<?>	file(String path)	Returns a new FileRequest that is used to retrieve the file in the Central Dogma repository.
int	hashCode()
HistoryRequest	history()	Returns a new HistoryRequest that is used to retrieve the history of all files in the Central Dogma repository.
HistoryRequest	history(PathPattern pathPattern)	Returns a new HistoryRequest that is used to retrieve the history of files in the Central Dogma repository.
<T> MergeRequest<T>	merge(MergeQuery<T> mergeQuery)	Returns a new MergeRequest that is used to retrieve the merged file in the Central Dogma repository.
MergeRequest<?>	merge(MergeSource... mergeSources)	Returns a new MergeRequest that is used to retrieve the merged file in the Central Dogma repository.
MergeRequest<?>	merge(Iterable<MergeSource> mergeSources)	Returns a new MergeRequest that is used to retrieve the merged file in the Central Dogma repository.
CompletableFuture<Revision>	normalize(Revision revision)	Converts the relative revision number to the absolute revision number. e.g.
String	projectName()	Returns the name of the project.
String	repositoryName()	Returns the name of the repository.
String	toString()
WatchFilesRequest	watch(PathPattern pathPattern)	Returns a new WatchFilesRequest that is used to watch the files in the Central Dogma repository.
<T> WatchRequest<T>	watch(Query<T> query)	Returns a new WatchRequest that is used to watch the file in the Central Dogma repository.
WatchRequest<?>	watch(String path)	Returns a new WatchRequest that is used to watch the file in the Central Dogma repository.
WatcherRequest<Revision>	watcher(PathPattern pathPattern)	Returns a new WatcherRequest that is used to create a Watcher.
<T> WatcherRequest<T>	watcher(Query<T> query)	Returns a new WatcherRequest that is used to create a Watcher.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

projectName

public String projectName()

Returns the name of the project.

repositoryName

public String repositoryName()

Returns the name of the repository.

normalize

public CompletableFuture<Revision> normalize(Revision revision)

Converts the relative revision number to the absolute revision number. e.g. -1 -> 3

Returns:

the absolute Revision

file

public FileRequest<?> file(String path)

Returns a new FileRequest that is used to retrieve the file in the Central Dogma repository. Call FileRequest.get(Revision) to perform the same operation as CentralDogma.getFile(String, String, Revision, Query).

file

public <T> FileRequest<T> file(Query<T> query)

Returns a new FileRequest that is used to retrieve the file in the Central Dogma repository. Call FileRequest.get(Revision) to perform the same operation as CentralDogma.getFile(String, String, Revision, Query).

file

public FilesRequest file(PathPattern pathPattern)

Returns a new FilesRequest that is used to retrieve or list files in the Central Dogma repository. Call FilesRequest.get(Revision) or FilesRequest.list(Revision) for those operation.

merge

public MergeRequest<?> merge(MergeSource... mergeSources)

Returns a new MergeRequest that is used to retrieve the merged file in the Central Dogma repository. Call MergeRequest.get(Revision) to perform the same operation as CentralDogma.mergeFiles(String, String, Revision, MergeQuery).

merge

public MergeRequest<?> merge(Iterable<MergeSource> mergeSources)

Returns a new MergeRequest that is used to retrieve the merged file in the Central Dogma repository. Call MergeRequest.get(Revision) to perform the same operation as CentralDogma.mergeFiles(String, String, Revision, MergeQuery).

merge

public <T> MergeRequest<T> merge(MergeQuery<T> mergeQuery)

Returns a new MergeRequest that is used to retrieve the merged file in the Central Dogma repository. Call MergeRequest.get(Revision) to perform the same operation as CentralDogma.mergeFiles(String, String, Revision, MergeQuery).

history

public HistoryRequest history()

Returns a new HistoryRequest that is used to retrieve the history of all files in the Central Dogma repository. Call HistoryRequest.get(Revision, Revision) to perform the same operation as CentralDogma.getHistory(String, String, Revision, Revision, PathPattern, int).

history

public HistoryRequest history(PathPattern pathPattern)

Returns a new HistoryRequest that is used to retrieve the history of files in the Central Dogma repository. Call HistoryRequest.get(Revision, Revision) to perform the same operation as CentralDogma.getHistory(String, String, Revision, Revision, PathPattern, int).

diff

public DiffRequest<?> diff(String path)

Returns a new DiffRequest that is used to retrieve the diff of the file in the Central Dogma repository. Call DiffRequest.get(Revision, Revision) to perform the same operation as CentralDogma.getDiff(String, String, Revision, Revision, Query).

diff

public <T> DiffRequest<T> diff(Query<T> query)

Returns a new DiffRequest that is used to retrieve the diff of the file in the Central Dogma repository. Call DiffRequest.get(Revision, Revision) to perform the same operation as CentralDogma.getDiff(String, String, Revision, Revision, Query).

diff

public DiffFilesRequest diff(PathPattern pathPattern)

Returns a new DiffFilesRequest that is used to retrieve the diff of files in the Central Dogma repository. Call DiffFilesRequest.get(Revision, Revision) to perform the same operation as CentralDogma.getDiff(String, String, Revision, Revision, PathPattern).

diff

public PreviewDiffRequest diff(Change<?>... changes)

Returns a new PreviewDiffRequest that is used to retrieve the preview diff of files in the Central Dogma repository. Call PreviewDiffRequest.get(Revision) to perform the same operation as CentralDogma.getPreviewDiffs(String, String, Revision, Iterable).

diff

public PreviewDiffRequest diff(Iterable<? extends Change<?>> changes)

Returns a new PreviewDiffRequest that is used to retrieve the preview diff of files in the Central Dogma repository. Call PreviewDiffRequest.get(Revision) to perform the same operation as CentralDogma.getPreviewDiffs(String, String, Revision, Iterable).

commit

public CommitRequest commit(String summary,
 Change<?>... changes)

Returns a new CommitRequest that is used to push the Changes to the Central Dogma repository. Call CommitRequest.push(Revision) to perform the same operation as CentralDogma.push(String, String, Revision, String, String, Markup, Iterable).

commit

public CommitRequest commit(String summary,
 Iterable<? extends Change<?>> changes)

Returns a new CommitRequest that is used to push the Changes to the Central Dogma repository. Call CommitRequest.push(Revision) to perform the same operation as CentralDogma.push(String, String, Revision, String, String, Markup, Iterable).

watch

public WatchRequest<?> watch(String path)

Returns a new WatchRequest that is used to watch the file in the Central Dogma repository. Call WatchRequest.start(Revision) to perform the same operation as CentralDogma.watchFile(String, String, Revision, Query, long, boolean).

watch

public <T> WatchRequest<T> watch(Query<T> query)

Returns a new WatchRequest that is used to watch the file in the Central Dogma repository. Call WatchRequest.start(Revision) to perform the same operation as CentralDogma.watchFile(String, String, Revision, Query, long, boolean).

watch

public WatchFilesRequest watch(PathPattern pathPattern)

Returns a new WatchFilesRequest that is used to watch the files in the Central Dogma repository. Call WatchFilesRequest.start(Revision) to perform the same operation as CentralDogma.watchRepository(String, String, Revision, PathPattern, long, boolean).

watcher

public <T> WatcherRequest<T> watcher(Query<T> query)

Returns a new WatcherRequest that is used to create a Watcher.

watcher

public WatcherRequest<Revision> watcher(PathPattern pathPattern)

Returns a new WatcherRequest that is used to create a Watcher.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object