Package com.spotify.github.v3.prs

Class ReviewComment

  • Direct Known Subclasses:
    ImmutableReviewComment
    @Immutable
public abstract class ReviewComment
extends java.lang.Object
    Comment parameters for a draft review.
    See Also:
    "https://developer.github.com/v3/pulls/reviews/#input"

    • Constructor Summary

      Constructors 
      Constructor Description
      ReviewComment()  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.lang.String body()
      Text of the review comment.
      abstract java.lang.String path()
      Relative path to the file that necessitates a review comment.
      abstract int position()
      Position in the diff where you want to add a review comment.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReviewComment

        public ReviewComment()

    • Method Detail

      • path

        public abstract java.lang.String path()
        Relative path to the file that necessitates a review comment.
        Returns:
        the path to the file.

      • position

        public abstract int position()
        Position in the diff where you want to add a review comment.
        Returns:
        the position in the diff.

      • body

        public abstract java.lang.String body()
        Text of the review comment.
        Returns:
        the text of the review.