ReviewInput.java

/*
 *  The MIT License
 *
 *  Copyright 2013 Jyrki Puttonen. All rights reserved.
 *  Copyright 2013 Sony Mobile Communications AB. All rights reserved.
 *
 *  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 com.sonymobile.tools.gerrit.gerritevents.dto.rest;


import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

//CS IGNORE LineLength FOR NEXT 6 LINES. REASON: JavaDoc.
/**
 * What to send as input to the actual review.
 *
 * @see <a href="https://gerrit-documentation.storage.googleapis.com/Documentation/2.7/rest-api-changes.html#set-review">Gerrit Documentation</a>
 */
public class ReviewInput {
    final String message;
    final Map<String, Integer> labels = new HashMap<String, Integer>();
    final Map<String, List<LineComment>> comments = new HashMap<String, List<LineComment>>();
    Notify notify;

    /**
     * Standard Constructor.
     *
     * @param message    message
     * @param labelName  label
     * @param labelValue value
     */
    public ReviewInput(String message, String labelName, int labelValue) {
        this(message, Collections.singleton(new ReviewLabel(labelName, labelValue)));
    }

    /**
     * Standard Constructor.
     *
     * @param message message
     * @param labels  labels
     */
    public ReviewInput(String message, ReviewLabel... labels) {
        this(message, Arrays.asList(labels));
    }

    /**
     * Standard Constructor.
     *
     * @param message message
     * @param labels  labels
     */
    public ReviewInput(String message, Collection<ReviewLabel> labels) {
        this(message, labels, Collections.<CommentedFile>emptyList());
    }

    /**
     * Standard Constructor.
     *
     * @param message        message
     * @param commentedFiles file comments
     * @param labels         label
     */
    public ReviewInput(String message, Collection<CommentedFile> commentedFiles, ReviewLabel... labels) {
        this(message, Arrays.asList(labels), commentedFiles);
    }

    /**
     * Standard Constructor.
     *
     * @param message        message
     * @param labels         labels
     * @param commentedFiles file comments
     */
    public ReviewInput(String message, Collection<ReviewLabel> labels, Collection<CommentedFile> commentedFiles) {
        this.message = message;
        for (ReviewLabel label : labels) {
            this.labels.put(label.getName(), label.getValue());
        }
        for (CommentedFile file : commentedFiles) {
            if (!comments.containsKey(file.getFileName())) {
                comments.put(file.getFileName(), new ArrayList<LineComment>());
            }
            comments.get(file.getFileName()).addAll(file.getLineComments());
        }
    }

    /**
     * Sets the 'notify' value.  Defines to whom email notifications should be sent after the review is stored.
     *
     * @param value the value to set.
     * @return this instance for convenience
     */
    public ReviewInput setNotify(Notify value) {
        this.notify = value;
        return this;
    }
}