GHCompare.java
package org.kohsuke.github;
import com.fasterxml.jackson.annotation.JacksonInject;
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
import java.net.URL;
import java.util.Collections;
import java.util.Iterator;
import javax.annotation.Nonnull;
// TODO: Auto-generated Javadoc
/**
* The model user for comparing 2 commits in the GitHub API.
*
* @author Michael Clarke
*/
public class GHCompare {
private String url, html_url, permalink_url, diff_url, patch_url;
private Status status;
private int ahead_by, behind_by, total_commits;
private Commit base_commit, merge_base_commit;
private Commit[] commits;
private GHCommit.File[] files;
private GHRepository owner;
@JacksonInject("GHCompare_usePaginatedCommits")
private boolean usePaginatedCommits;
/**
* Gets url.
*
* @return the url
*/
public URL getUrl() {
return GitHubClient.parseURL(url);
}
/**
* Gets html url.
*
* @return the html url
*/
public URL getHtmlUrl() {
return GitHubClient.parseURL(html_url);
}
/**
* Gets permalink url.
*
* @return the permalink url
*/
public URL getPermalinkUrl() {
return GitHubClient.parseURL(permalink_url);
}
/**
* Gets diff url.
*
* @return the diff url
*/
public URL getDiffUrl() {
return GitHubClient.parseURL(diff_url);
}
/**
* Gets patch url.
*
* @return the patch url
*/
public URL getPatchUrl() {
return GitHubClient.parseURL(patch_url);
}
/**
* Gets status.
*
* @return the status
*/
public Status getStatus() {
return status;
}
/**
* Gets ahead by.
*
* @return the ahead by
*/
public int getAheadBy() {
return ahead_by;
}
/**
* Gets behind by.
*
* @return the behind by
*/
public int getBehindBy() {
return behind_by;
}
/**
* Gets total commits.
*
* @return the total commits
*/
public int getTotalCommits() {
return total_commits;
}
/**
* Gets base commit.
*
* @return the base commit
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
public Commit getBaseCommit() {
return base_commit;
}
/**
* Gets merge base commit.
*
* @return the merge base commit
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
public Commit getMergeBaseCommit() {
return merge_base_commit;
}
/**
* Gets an array of commits.
*
* By default, the commit list is limited to 250 results.
*
* Since
* <a href="https://github.blog/changelog/2021-03-22-compare-rest-api-now-supports-pagination/">2021-03-22</a>,
* compare supports pagination of commits. This makes the initial {@link GHCompare} response return faster and
* supports comparisons with more than 250 commits. To read commits progressively using pagination, set
* {@link GHRepository#setCompareUsePaginatedCommits(boolean)} to true before calling
* {@link GHRepository#getCompare(String, String)}.
*
* @return A copy of the array being stored in the class.
*/
public Commit[] getCommits() {
try {
return listCommits().withPageSize(100).toArray();
} catch (IOException e) {
throw new GHException(e.getMessage(), e);
}
}
/**
* Iterable of commits for this comparison.
*
* By default, the commit list is limited to 250 results.
*
* Since
* <a href="https://github.blog/changelog/2021-03-22-compare-rest-api-now-supports-pagination/">2021-03-22</a>,
* compare supports pagination of commits. This makes the initial {@link GHCompare} response return faster and
* supports comparisons with more than 250 commits. To read commits progressively using pagination, set
* {@link GHRepository#setCompareUsePaginatedCommits(boolean)} to true before calling
* {@link GHRepository#getCompare(String, String)}.
*
* @return iterable of commits
*/
public PagedIterable<Commit> listCommits() {
if (usePaginatedCommits) {
return new GHCompareCommitsIterable();
} else {
// if not using paginated commits, adapt the returned commits array
return new PagedIterable<Commit>() {
@Nonnull
@Override
public PagedIterator<Commit> _iterator(int pageSize) {
return new PagedIterator<>(Collections.singleton(commits).iterator(), null);
}
};
}
}
/**
* Gets an array of files.
*
* By default, the file array is limited to 300 results. To retrieve the full list of files, iterate over each
* commit returned by {@link GHCompare#listCommits} and use {@link GHCommit#listFiles} to get the files for each
* commit.
*
* @return A copy of the array being stored in the class.
*/
public GHCommit.File[] getFiles() {
GHCommit.File[] newValue = new GHCommit.File[files.length];
System.arraycopy(files, 0, newValue, 0, files.length);
return newValue;
}
/**
* Wrap gh compare.
*
* @param owner
* the owner
* @return the gh compare
*/
@Deprecated
public GHCompare wrap(GHRepository owner) {
throw new RuntimeException("Do not use this method.");
}
/**
* Wrap gh compare.
*
* @param owner
* the owner
* @return the gh compare
*/
GHCompare lateBind(GHRepository owner) {
this.owner = owner;
for (Commit commit : commits) {
commit.wrapUp(owner);
}
merge_base_commit.wrapUp(owner);
base_commit.wrapUp(owner);
return this;
}
/**
* Compare commits had a child commit element with additional details we want to capture. This extension of GHCommit
* provides that.
*/
@SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD" },
justification = "JSON API")
public static class Commit extends GHCommit {
private InnerCommit commit;
/**
* Gets commit.
*
* @return the commit
*/
public InnerCommit getCommit() {
return commit;
}
}
/**
* The type InnerCommit.
*/
public static class InnerCommit {
private String url, sha, message;
private User author, committer;
private Tree tree;
/**
* Gets url.
*
* @return the url
*/
public String getUrl() {
return url;
}
/**
* Gets sha.
*
* @return the sha
*/
public String getSha() {
return sha;
}
/**
* Gets message.
*
* @return the message
*/
public String getMessage() {
return message;
}
/**
* Gets author.
*
* @return the author
*/
@WithBridgeMethods(value = User.class, castRequired = true)
public GitUser getAuthor() {
return author;
}
/**
* Gets committer.
*
* @return the committer
*/
@WithBridgeMethods(value = User.class, castRequired = true)
public GitUser getCommitter() {
return committer;
}
/**
* Gets tree.
*
* @return the tree
*/
public Tree getTree() {
return tree;
}
}
/**
* The type Tree.
*/
public static class Tree {
private String url, sha;
/**
* Gets url.
*
* @return the url
*/
public String getUrl() {
return url;
}
/**
* Gets sha.
*
* @return the sha
*/
public String getSha() {
return sha;
}
}
/**
* The type User.
*
* @deprecated use {@link GitUser} instead.
*/
public static class User extends GitUser {
}
/**
* The enum Status.
*/
public static enum Status {
/** The behind. */
behind,
/** The ahead. */
ahead,
/** The identical. */
identical,
/** The diverged. */
diverged
}
/**
* Iterable for commit listing.
*/
class GHCompareCommitsIterable extends PagedIterable<Commit> {
private GHCompare result;
/**
* Instantiates a new GH compare commits iterable.
*/
public GHCompareCommitsIterable() {
}
/**
* Iterator.
*
* @param pageSize
* the page size
* @return the paged iterator
*/
@Nonnull
@Override
public PagedIterator<Commit> _iterator(int pageSize) {
GitHubRequest request = owner.root()
.createRequest()
.injectMappingValue("GHCompare_usePaginatedCommits", usePaginatedCommits)
.withUrlPath(owner.getApiTailUrl(url.substring(url.lastIndexOf("/compare/"))))
.build();
// page_size must be set for GHCompare commit pagination
if (pageSize == 0) {
pageSize = 10;
}
return new PagedIterator<>(
adapt(GitHubPageIterator.create(owner.root().getClient(), GHCompare.class, request, pageSize)),
item -> item.wrapUp(owner));
}
/**
* Adapt.
*
* @param base
* the base
* @return the iterator
*/
protected Iterator<Commit[]> adapt(final Iterator<GHCompare> base) {
return new Iterator<Commit[]>() {
public boolean hasNext() {
return base.hasNext();
}
public Commit[] next() {
GHCompare v = base.next();
if (result == null) {
result = v;
}
return v.commits;
}
};
}
}
}