CommitService

Adds a general comment on the specified commit in the specified repository.

Adds a line comment to a commit diff in the specified repository.

The request's toHash should generally be omitted. If it is provided, it must match the commitId. For merge commits, which have a diff for each parent, the desired diff can be selected by providing the parent's ID in the fromHash. If the fromHash is null, the first parent will be assumed.

Adds a file-level comment to a commit diff in the specified repository.

The request's toHash should generally be omitted. If it is provided, it must match the commitId. For merge commits, which have a diff for each parent, the desired diff can be selected by providing the parent's ID in the fromHash. If the fromHash is null, the first parent will be assumed.

Adds a reply to a comment.

Deletes a comment.

Finds anchors for file and line comments on the specified path in the commit. For merge commits, which have a diff for each parent, the parent ID can also be provided to select the diff to retrieve comments from.

Retrieves a page of changes between two commits. If the since commit is not specified, the until commit's first parent is used.

Retrieves the most recent changeset affecting the specified repository and path, starting from the changeset identified by changesetId, which may be a commit, branch or tag.

Retrieves a changeset by its id or the most recent changeset affecting a branch or tag. The specified attributesToLoad will also be loaded. These attributes are metadata associated with the changeset by a given ChangesetIndexer.

Retrieves a changeset by its id or the most recent changeset affecting a branch or tag.

Retrieves the most recent changeset affecting the specified repository and path, starting from the changeset identified by changesetId, which may be a commit, branch or tag. The specified attributesToLoad will also be loaded. These attributes are metadata associated with the changeset by a given ChangesetIndexer.

Retrieves a page of changesets for the provided path on the specified branch.

If the provided changesetId is null, the default branch for the repository will be assumed. If the path is null, changesets are returned starting from (and including) the provided changesetId (where, again, the repository's default branch will be used if null). As a result this service call may be used to:

• Retrieve pages of changesets on a given branch or tag
• Retrieve pages of ancestral changesets for a given changeset
• Retrieve pages of changesets where a given file has be modified

Note: If the provided path is renamed at some point in its history, changesets will not follow the path across the rename. In other words, only changesets for the exact path provided will be included.

Retrieves changesets for each of the requested getCommitIds() commits}, including the first page of changes between each commit and its first parent.

If the page size is less than the size of the collection of IDs, a subset of the collection will be returned. Otherwise, changesets for all IDs in the requested collection are returned.

Note: "Changeset" in this context represents a fundamentally different concept than the previous, now-deprecated Changeset class. This is the replacement for getDetailedChangesets(DetailedChangesetsRequest, PageRequest), which is also deprecated and will be removed in 5.0 along with DetailedChangeset. See Changeset for a description of what a "changeset" is, compared to a commit.

Retrieves a page of changesets for the provided path on the specified branch.

If the provided changesetId is null, the default branch for the repository will be assumed. If the path is null, changesets are returned starting from (and including) the provided changesetId (where, again, the repository's default branch will be used if null). As a result this service call may be used to:

• Retrieve pages of changesets on a given branch or tag
• Retrieve pages of ancestral changesets for a given changeset
• Retrieve pages of changesets where a given file has be modified

Note: If the provided path is renamed at some point in its history, changesets will not follow the path across the rename. In other words, only changesets for the exact path provided will be included.

Retrieves a page of changesets between the included changesets and the excluded changesets. Included and excluded changesets may be specified by branch or tag name or by hash. The changesets returned are those which are reachable an included changeset and not reachable from any excluded changeset. While this may imply an ancestral relationship between include and exclude IDs, that is not strictly required. When the IDs are unrelated, all changesets referenceable from included changesets are candidates for the returned page, and excluded changesets are effectively ignored. Paths may be provided to further narrow the results, restricting the returned changesets to only those affecting one or more of the specified paths.

Which changesets are included and which are excluded is important here. Consider the following example:

1. Branch "feature-A" was created from "master" when "master" was at changeset A
2. Changesets FA1, FA2 and FA3 were created on the "feature-A" branch
3. Changesets B and C were made on "master" after the branch was created

 ---- A ---- B ---- C
       \
        \
        FA1 ---- FA2 ---- FA3
 

Warning: Changesets specified using branch or tag names, will be resolved against the primary repository. When retrieving changesets between repositories, changesets in the secondary repository may only be specified by hash. This means requesting a page like this will not work:

     ChangesetsBetweenRequest request = new ChangesetsBetweenRequest.Builder(repository)
             .exclude("master")
             .include("master")
             .secondaryRepository(forkOfRepository)
             .build();
     Page<Changeset> page = commitService.getChangesetsBetween(request, PageUtils.newRequest(0, 25));
 

Retrieves a the specified comment by its ID.

Retrieves a commit based on te provided request.

If only a commit ID is specified, that commit will be returned if it exists. If a path is also provided, the first commit starting from the specified commit ID which modifies that path is returned. If the specified commit does not exist, or if no commit in the ancestry of that commit modifies the specified path, a NoSuchCommitException is thrown.

When retrieving a commit, extra properties can also be loaded. Properties are metadata associated with commits by CommitIndexers. Until 4.0, the extra properties requested also control the attributes that are loaded. Attributes will be removed in 4.0.

Retrieves a page of commits, starting from a given branch, tag or commit, optionally filtered to only return commits which modify one or more paths. Commits are returned starting from (and including) the specified getCommitId(), unless one or more paths are provided. Then the first commit returned, if any are returned, will be the first commit in the ancestry of the specified starting commit which modifies at least one of the specified files.

This service call may be used to:

• Retrieve pages of commits on a given branch or tag
• Retrieve pages of ancestors starting from a given commit
• Retrieve pages of commits where at least one file from a specified set of files has been modified

When retrieving commits, extra properties can also be loaded. Properties are metadata associated with commits by CommitIndexers. Until 4.0, the extra properties requested also control the attributes that are loaded. Attributes will be removed in 4.0.

Note: If any of the provided paths is renamed at some point in its history, commits will not follow the path across the rename. In other words, only commits for exact paths provided will be included.

Retrieves a page of commits between the included commits and the excluded commits. Included and excluded commits may be specified by branch or tag name or by commit ID. The commits returned are those which are reachable an included commit and not reachable from any excluded commit. While this may imply an ancestral relationship between included and excluded IDs, that is not strictly required. When the IDs are unrelated, all commits reachable from the included commits are candidates for the returned page, and excluded commits are effectively ignored. One or more paths may be provided to further narrow the results, restricting the returned commits to only which modify one or more of the specified paths.

Which commits are included and which are excluded is important here. Consider the following example:

1. Branch "feature-A" was created from "master" when "master" was at commit A
2. Commits FA1, FA2 and FA3 were created on the "feature-A" branch
3. Commits B and C were made on "master" after the branch was created

 ---- A ---- B ---- C
       \
        \
        FA1 ---- FA2 ---- FA3
 

When retrieving commits, extra properties can also be loaded. Properties are metadata associated with commits by CommitIndexers. Until 4.0, the extra properties requested also control the attributes that are loaded. Attributes will be removed in 4.0.

Warning: Commits specified using branch or tag names will be resolved against the primary repository. When retrieving commits between repositories, commits in the secondary repository may only be specified by commit ID. This means requesting a page like this will not work:

     CommitsBetweenRequest request = new CommitsBetweenRequest.Builder(repository)
             .exclude("master")
             .include("master")
             .secondaryRepository(forkOfRepository)
             .build();
     Page<Commit> page = commitService.getCommitsBetween(request, PageUtils.newRequest(0, 25));
 

Retrieves each of the changesets in getChangesetIds() changesetIds} and returns their details, including the first page of changes between the changeset in question and its first parent.

If the page size is less than the size of the collection of IDs, a subset of the collection will be returned. Otherwise, detailed changesets for all IDs in the requested collection are returned.

Streams changes between the until and since changesets. If the since changeset is not specified, the until changeset's first parent is used automatically.

Streams changesets between the included changesets and the excluded changesets.

This method promises to call onStart(ChangesetContext) on the supplied callback once followed by zero or more calls to onChangeset(Changeset), one for each changeset to be streamed (until false is returned by onChangeset(...) or there are no more changesets), followed by a single call to onEnd(ChangesetSummary).

See getChangesetsBetween(...) for a description of the semantics of the changesets returned.

Streams commits, starting from a given branch, tag or commit, optionally filtered to only include commits which modify one or more paths. Commits are streamed starting from (and including) the specified getCommitId(), unless one or more paths are provided. Then the first commit streamed, if any are, will be the first commit in the ancestry of the specified starting commit which modifies at least one of the specified files.

This service call may be used to:

• Stream the commits on a given branch or tag
• Stream ancestors starting from a given commit
• Stream commits where at least one file from a specified set of files has been modified

When streaming commits, extra properties can also be loaded. Properties are metadata associated with commits by CommitIndexers. Until 4.0, the extra properties requested also control the attributes that are loaded. Attributes will be removed in 4.0.

Note: If any of the provided paths is renamed at some point in its history, commits will not follow the path across the rename. In other words, only commits for exact paths provided will be included.

Streams commits between the included commits and the excluded commits.

This method promises to call onStart(CommitContext) on the supplied callback exactly once, followed by zero or more calls to onCommit(Commit), one for each commit to be streamed (until onCommit(...) returns false or there are no more commits), followed by exactly one call to onEnd(CommitSummary).

See getCommitsBetween(...) for a description of the semantics of the commits returned.

Streams diff output for the specified paths at the specified changeset.

Note: This interface is currently not paged. The implementation will apply a hard cap and it is not possible to request subsequent content when that cap is exceeded.

Traverse the graph of commits in topological order, optionally supplying included commits to start from and excluded commits to ignore.

Removes the current user as a watcher for the specified commit, which will prevent further notifications from being dispatched to that user.

Updates the text for the specified comment.

Adds the current user as a watcher for the specified commit. Watchers receive notifications when new comments are added to the commit.