com.github.shredder121.gh_event_api.model.Comment Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Shredder121.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.shredder121.gh_event_api.model;

import java.time.ZonedDateTime;

import com.fasterxml.jackson.databind.PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy;
import com.fasterxml.jackson.databind.annotation.JsonNaming;
import com.github.shredder121.gh_event_api.model.json.PropertyBasedJsonCreator;

/**
 * A comment on a part of the commit diff.
 *
 * @author Shredder121
 */
@lombok.Value
@JsonNaming(LowerCaseWithUnderscoresStrategy.class)
@lombok.AllArgsConstructor(
        access = lombok.AccessLevel.PACKAGE,
        onConstructor = @__(@PropertyBasedJsonCreator)
)
public class Comment {

    /**
     * The id of the comment, for GitHub bookkeeping.
     */
    Integer id;

    /**
     * The line index in the diff.
     */
    Integer position;

    /**
     * The original line number of the comment in the diff.
     * (Only applicable to pull request review comments)
     */
    Integer originalPosition;

    /**
     * The relative path of the file that is being commented on.
     */
    String path;

    /**
     * The commit hash that is being commented on.
     */
    String commitId;

    /**
     * The commit hash the comment was originally for.
     * (Only applicable to pull request review comments)
     */
    String originalCommitId;

    /**
     * The body of the comment.
     */
    String body;

    /**
     * The part of the diff that was commented on.
     * (Only applicable to pull request review comments)
     */
    String diffHunk;

    /**
     * The (API) URL to view this commit comment.
     */
    String url;

    /**
     * The (GitHub Web UI) URL to view this commit comment.
     */
    String htmlUrl;

    /**
     * The time the comment was created.
     */
    ZonedDateTime createdAt;

    /**
     * The time the comment was last modified.
     */
    ZonedDateTime updatedAt;
}