com.sonymobile.tools.gerrit.gerritevents.dto.attr.Change Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-events Show documentation
Java client library for receiving stream-events from Gerrit code review. As well as performing queries and sending reviews.
The newest version!
/*
 *  The MIT License
 *
 *  Copyright 2010 Sony Mobile Communications Inc. 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.attr;

import com.sonymobile.tools.gerrit.gerritevents.GerritQueryHandler;
import com.sonymobile.tools.gerrit.gerritevents.dto.GerritChangeStatus;
import com.sonymobile.tools.gerrit.gerritevents.dto.GerritJsonDTO;

import com.sonymobile.tools.gerrit.gerritevents.dto.rest.Topic;
import com.sonymobile.tools.gerrit.gerritevents.helpers.FileHelper;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import org.apache.commons.lang.StringUtils;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.List;

import static com.sonymobile.tools.gerrit.gerritevents.GerritJsonEventFactory.getBoolean;
import static com.sonymobile.tools.gerrit.gerritevents.GerritJsonEventFactory.getString;
import static com.sonymobile.tools.gerrit.gerritevents.GerritJsonEventFactory.getDate;

import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.BRANCH;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.COMMENTS;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.COMMIT_MESSAGE;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.TOPIC;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.HASHTAGS;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.ID;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.NUMBER;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.OWNER;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.PROJECT;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.SUBJECT;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.URL;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.CREATED_ON;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.LAST_UPDATED;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.STATUS;

import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.WIP;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.PRIVATE;

/**
 * Represents a Gerrit JSON Change DTO.
 * The Gerrit change the event is related to.
 * @author Robert Sandell <[email protected]>
 */
public class Change implements GerritJsonDTO {

    /**
     * Project path in Gerrit.
     */
    private String project;
    /**
     * Branch name within project.
     */
    private String branch;
    /**
     * Topic.
     */
    private Topic topicObject;
    /**
     * Topic name.
     */
    private transient String topic;
    /**
     * Hashtags.
     */
    private List hashtags;
    /**
     * Change identifier.
     */
    private String id;
    /**
     * Change number (deprecated).
     */
    private String number;
    /**
     * Description of change.
     */
    private String subject;
    /**
     * The change's full commit message.
     */
    private String commitMessage;
    /**
     * Owner in account attribute.
     */
    private Account owner;
    /**
     * Canonical URL to reach this change.
     */
    private String url;

    /**
     * The Date when this change was created.
     */
    private Date createdOn;

    /**
     * The Date when this change was last updated.
     */
    private Date lastUpdated;

    private List comments;

    /**
     * The changed files in this patchset.
     */
    private List files;

    /**
     * The change status.
     */
    private GerritChangeStatus status;

    /**
     * Converts old serialized data to newer construct.
     *
     * @return itself
     */
    @SuppressWarnings("unused")
    private Object readResolve() {
        if (StringUtils.isNotEmpty(topic)) {
            topicObject = new Topic(topic);
            topic = null;
        }

        if (topicObject != null && StringUtils.isEmpty(topicObject.getName())) {
            topicObject = null;
        }

        return this;
    }

    /**
     * Is this change a Work in progress.
     */
    private boolean wip;

    /**
     * Is this change private.
     */
    // CS IGNORE MemberName FOR NEXT 1 LINES. REASON: Private is a reserved keyword.
    private boolean _private;

    /**
     * Default constructor.
     */
    public Change() {
    }

    /**
     * Constructor that fills with data directly.
     * @param json the JSON Object with corresponding data.
     * @see #fromJson(net.sf.json.JSONObject)
     */
    public Change(JSONObject json) {
        this.fromJson(json);
    }

    @Override
    public void fromJson(JSONObject json) {
        project = getString(json, PROJECT);
        branch = getString(json, BRANCH);
        id = getString(json, ID);
        number = getString(json, NUMBER);
        subject = getString(json, SUBJECT);
        createdOn = getDate(json, CREATED_ON);
        lastUpdated = getDate(json, LAST_UPDATED);
        if (json.containsKey(OWNER)) {
            owner = new Account(json.getJSONObject(OWNER));
        }
        if (json.containsKey(COMMENTS)) {
            comments = new ArrayList();
            JSONArray eventApprovals = json.getJSONArray(COMMENTS);
            for (int i = 0; i < eventApprovals.size(); i++) {
                comments.add(new Comment(eventApprovals.getJSONObject(i)));
            }
        }
        if (json.containsKey(COMMIT_MESSAGE)) {
            commitMessage = getString(json, COMMIT_MESSAGE);
        }
        if (json.containsKey(TOPIC)) {
            String topicName = getString(json, TOPIC);
            if (StringUtils.isNotEmpty(topicName)) {
                topicObject = new Topic(topicName);
            }
        }

        if (json.containsKey(HASHTAGS)) {
            JSONArray tags = json.getJSONArray(HASHTAGS);
            hashtags = new ArrayList(tags.size());
            for (int i = 0; i < tags.size(); i++) {
                hashtags.add(tags.getString(i));
            }
        } else {
            hashtags = Collections.emptyList();
        }

        url = getString(json, URL);
        status = GerritChangeStatus.fromString(getString(json, STATUS));
        wip = getBoolean(json, WIP, false);
        _private = getBoolean(json, PRIVATE, false);
    }

    /**
     * Branch name within project.
     * @return the branch.
     */
    public String getBranch() {
        return branch;
    }

    /**
     * Branch name within project.
     * @param branch the branch.
     */
    public void setBranch(String branch) {
        this.branch = branch;
    }

    /**
     * Comments (only filled up if getComments equals true during query).
     * @return the comments list.
     */
    public List getComments() {
        return comments;
    }

    /**
     * Change status.
     * @return the change status.
     */
    public GerritChangeStatus getStatus() {
        return status;
    }

    /**
     * Sets the change status.
     * @param status the status.
     */
    public void setStatus(GerritChangeStatus status) {
        this.status = status;
    }

    /**
     * The topic info related to this change. Can be null if there is no topic.
     * @return the topic.
     */
    public Topic getTopicObject() {
        return topicObject;
    }

    /**
     * Shortcut for {@code getTopicObject() != null ? getTopicObject().getName() : null}.
     * @return the topic name if exists. null otherwise.
     */
    public String getTopic() {
        if (topicObject == null) {
            return null;
        }
        return topicObject.getName();
    }

    /**
     * Sets the topic info related to this change.
     * @param topicName the topic name.
     */
    public void setTopic(String topicName) {
        topicObject = new Topic(topicName);
    }

    /**
     * Sets the topic info related to this change.
     * @param topicObject the topic.
     */
    public void setTopicObject(Topic topicObject) {
        this.topicObject = topicObject;
    }

    /**
     * Change hashtags.
     * @return the hashtags.
     */
    public List getHashtags() {
        return hashtags;
    }

    /**
     * Sets the hashtags to this change.
     * @param hashtags the hashtags.
     */
    public void setHashtags(List hashtags) {
        this.hashtags = hashtags;
    }

    /**
     * Change identifier.
     * @return the identifier.
     */
    public String getId() {
        return id;
    }

    /**
     * Change identifier.
     * @param id the identifier.
     */
    public void setId(String id) {
        this.id = id;
    }

    /**
     * Change number (deprecated).
     * @return the change number.
     * @deprecated because the Gerrit documentation says so.
     */
    public String getNumber() {
        return number;
    }

    /**
     * Change number (deprecated).
     * @param number the change number.
     * @deprecated because the Gerrit documentation says so.
     */
    public void setNumber(String number) {
        this.number = number;
    }

    /**
     * Owner in account attribute.
     * @return the owner.
     */
    public Account getOwner() {
        return owner;
    }

    /**
     * Owner in account attribute.
     * @param owner the owner.
     */
    public void setOwner(Account owner) {
        this.owner = owner;
    }

    /**
     * Project path in Gerrit.
     * @return the project.
     */
    public String getProject() {
        return project;
    }

    /**
     * Project path in Gerrit.
     * @param project the project.
     */
    public void setProject(String project) {
        this.project = project;
    }

    /**
     * Description of change.
     * @return the description.
     */
    public String getSubject() {
        return subject;
    }

    /**
     * Description of change.
     * @param subject the description.
     */
    public void setSubject(String subject) {
        this.subject = subject;
    }

    /**
     * Full commit message.
     * @return the commit message.
     */
    public String getCommitMessage() {
        return commitMessage;
    }

    /**
     * Full commit message.
     * @param commitMessage the commit message.
     */
    public void setCommitMessage(String commitMessage) {
        this.commitMessage = commitMessage;
    }

    /**
     * Canonical URL to reach this change.
     * @return the URL.
     */
    public String getUrl() {
        return url;
    }

    /**
     * Canonical URL to reach this change.
     * @param url the URL.
     */
    public void setUrl(String url) {
        this.url = url;
    }

    /**
     * The Date this change was created on.
     * @return the Date.
     */
    public Date getCreatedOn() {
        return createdOn;
    }

    /**
     * The Date this change was created on.
     * @param date the Date.
     */
    public void setCreatedOn(Date date) {
        this.createdOn = date;
    }

    /**
     * The Date this change was last updated.
     * @return the Date.
     */
    public Date getLastUpdated() {
        return lastUpdated;
    }

    /**
     * The Date this change was last updated.
     * @param date the Date.
     */
    public void setLastUpdated(Date date) {
        this.lastUpdated = date;
    }

    /**
     * Is this change a work in progress.
     * @return change is in WIP state.
     */
    public boolean isWip() { return wip; }

    /**
     * Is this change a work in progress.
     * @param wip change is in WIP state.
     */
    public void setWip(boolean wip) { this.wip = wip; }

    /**
     * Is this change private.
     * @return change is in private state.
     */
    public boolean isPrivate() { return _private; }

    /**
     * Is this change private.
     * @param _private change is private.
     */
    // CS IGNORE HiddenField FOR NEXT 2 LINES. REASON: Private is a reserved keyword.
    // CS IGNORE ParameterName FOR NEXT 1 LINES. REASON: Private is a reserved keyword.
    public void setPrivate(boolean _private) { this._private = _private; }

    @Override
    public boolean equals(Object obj) {
        //CS IGNORE MagicNumber FOR NEXT 18 LINES. REASON: Autogenerated Code.
        //CS IGNORE AvoidInlineConditionals FOR NEXT 18 LINES. REASON: Autogenerated Code.
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final Change other = (Change)obj;
        if ((this.project == null) ? (other.project != null) : !this.project.equals(other.project)) {
            return false;
        }
        if ((this.branch == null) ? (other.branch != null) : !this.branch.equals(other.branch)) {
            return false;
        }
        if ((this.number == null) ? (other.number != null) : !this.number.equals(other.number)) {
            return false;
        }
        if ((this.id == null) ? (other.id != null) : !this.id.equals(other.id)) {
            return false;
        }
        return true;
    }

    @Override
    public int hashCode() {
        //CS IGNORE MagicNumber FOR NEXT 6 LINES. REASON: Autogenerated Code.
        //CS IGNORE AvoidInlineConditionals FOR NEXT 6 LINES. REASON: Autogenerated Code.
        int hash = 7;
        hash = 29 * hash + (this.project != null ? this.project.hashCode() : 0);
        hash = 29 * hash + (this.branch != null ? this.branch.hashCode() : 0);
        hash = 29 * hash + (this.number != null ? this.number.hashCode() : 0);
        hash = 29 * hash + (this.id != null ? this.id.hashCode() : 0);
        return hash;
    }

    @Override
    public String toString() {
        return "Change-Id for #" + getNumber() + ": " + getId();
    }

    /**
     * Returns change's info in string format.
     * @param preText the text before change info.
     * @return change info.
     */
    public String getChangeInfo(String preText) {
        StringBuilder s = new StringBuilder();
        s.append(preText + "\n");
        s.append("Subject: " + getSubject() + "\n");
        s.append("Project: " + getProject() + "  " + getBranch() + "  " + getId() + "\n");
        s.append("Link:    " + getUrl() + "\n");
        return s.toString();
    }

    /**
     * Sets the list of the files included in this patch set.
     * @param files a list of files.
     */
    public void setFiles(List files) {
        this.files = files;
    }

    /**
     * Queries gerrit for the files included in this patch set.
     *
     * @param gerritQueryHandler the query handler, responsible for the queries to gerrit.
     * @return a list of files that are part of this patch set.
     *
     */
    public List getFiles(GerritQueryHandler gerritQueryHandler) {
        if (files == null) {
            files = FileHelper.getFilesByChange(gerritQueryHandler, id);
        }
        return files;
    }
}