/* * The MIT License * * Copyright (c) 2010, Kohsuke Kawaguchi * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ package org.kohsuke.github; import java.io.IOException; import java.net.URL; import javax.annotation.CheckForNull; import static org.kohsuke.github.Previews.*; /** * Review comment to the pull request * * @author Julien Henry * @see GHPullRequest#listReviewComments() * @see GHPullRequest#createReviewComment(String, String, String, int) */ public class GHPullRequestReviewComment extends GHObject implements Reactable { GHPullRequest owner; private String body; private GHUser user; private String path; private int position = -1; private int original_position = -1; private long in_reply_to_id = -1L; /** * @deprecated * You should be using {@link GHPullRequestReviewBuilder#comment(String, String, int)} */ public static GHPullRequestReviewComment draft(String body, String path, int position) { GHPullRequestReviewComment result = new GHPullRequestReviewComment(); result.body = body; result.path = path; result.position = position; return result; } /*package*/ GHPullRequestReviewComment wrapUp(GHPullRequest owner) { this.owner = owner; return this; } /** * Gets the pull request to which this review comment is associated. */ public GHPullRequest getParent() { return owner; } /** * The comment itself. */ public String getBody() { return body; } /** * Gets the user who posted this comment. */ public GHUser getUser() throws IOException { return owner.root.getUser(user.getLogin()); } public String getPath() { return path; } @CheckForNull public int getPosition() { return position; } public int getOriginalPosition() { return original_position; } @CheckForNull public long getInReplyToId() { return in_reply_to_id; } @Override public URL getHtmlUrl() { return null; } protected String getApiRoute() { return "/repos/"+owner.getRepository().getFullName()+"/pulls/comments/"+id; } /** * Updates the comment. */ public void update(String body) throws IOException { new Requester(owner.root).method("PATCH").with("body", body).to(getApiRoute(),this); this.body = body; } /** * Deletes this review comment. */ public void delete() throws IOException { new Requester(owner.root).method("DELETE").to(getApiRoute()); } /** * Create a new comment that replies to this comment. */ public GHPullRequestReviewComment reply(String body) throws IOException { return new Requester(owner.root).method("POST") .with("body", body) .with("in_reply_to", getId()) .to(getApiRoute() + "/comments", GHPullRequestReviewComment.class) .wrapUp(owner); } @Preview @Deprecated public GHReaction createReaction(ReactionContent content) throws IOException { return new Requester(owner.root) .withPreview(SQUIRREL_GIRL) .with("content", content.getContent()) .to(getApiRoute()+"/reactions", GHReaction.class).wrap(owner.root); } @Preview @Deprecated public PagedIterable listReactions() { return new PagedIterable() { public PagedIterator _iterator(int pageSize) { return new PagedIterator(owner.root.retrieve().withPreview(SQUIRREL_GIRL).asIterator(getApiRoute() + "/reactions", GHReaction[].class, pageSize)) { @Override protected void wrapUp(GHReaction[] page) { for (GHReaction c : page) c.wrap(owner.root); } }; } }; } }