com.sonymobile.tools.gerrit.gerritevents.dto.attr.Approval 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 2012 Copyright 2012 Hewlett-Packard Development Company, L.P.
 *
 *  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 static com.sonymobile.tools.gerrit.gerritevents.GerritJsonEventFactory.getString;
import static com.sonymobile.tools.gerrit.gerritevents.GerritJsonEventFactory.getBoolean;
import com.sonymobile.tools.gerrit.gerritevents.dto.GerritJsonDTO;
import net.sf.json.JSONObject;

import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.BY;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.TYPE;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.VALUE;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.UPDATED;
import static com.sonymobile.tools.gerrit.gerritevents.dto.GerritEventKeys.OLD_VALUE;

/**
 * Represents a Gerrit JSON Approval DTO.
 *
 * @author James E. Blair <[email protected]>
 */
public class Approval implements GerritJsonDTO {

    /**
     * The approval category.
     */
    private String type;
    /**
     * The approval value
     */
    private String value;
    /**
     * Approval value update indicator
     */
    private Boolean updated;
    /**
     * The old (or previous) approval value
     */
    private String oldValue;
    /**
     * The user who has approved the patch
     */
    private Account by;

    /* username has been replaced by Approval.by Account.
     * This allows old builds to deserialize without warnings.
     * Below readResolve() method will handle the migration.
     * I can't flag it transient as it will skip the deserialization
     *  part, preventing any migration. */
    @SuppressWarnings("unused")
    private String username;

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



    /**
     * Constructor that fills with data directly.
     *
     * @param json the JSON object with corresponding data.
     */
    public Approval(JSONObject json) {
        this.fromJson(json);
    }

    @Override
    public void fromJson(JSONObject json) {
        if (json.containsKey(TYPE) && json.containsKey(VALUE)) {
            type = getString(json, TYPE);
            value = getString(json, VALUE);
        }
        if (json.containsKey(BY)) {
            by = new Account(json.getJSONObject(BY));
        }
        if (json.containsKey(UPDATED)) {
            updated = getBoolean(json, UPDATED);
        }
        if (json.containsKey(OLD_VALUE)) {
            oldValue = getString(json, OLD_VALUE);
        }
    }

    /**
     * The approval user.
     *
     * @return the username.
     */
    @Deprecated()
    public String getUsername() {
        if (by == null) {
            return null;
        } else {
            return by.getUsername();
        }
    }

    /**
     * The approval author account.
     *
     * @return the account
     */
    public Account getBy() {
        return by;
    }

    /**
     * The approval author account.
     *
     * @param by the account.
     */
    public void setBy(Account by) {
        this.by = by;
    }

    /**
     * The approval category.
     *
     * @return the type.
     */
    public String getType() {
        return type;
    }

    /**
     * The approval category.
     *
     * @param type the type.
     */
    public void setType(String type) {
        this.type = type;
    }

    /**
     * The approval value.
     *
     * @return the approval value.
     */
    public String getValue() {
        return value;
    }

    /**
     * The approval score updated flag.
     *
     *  @return true if approval score changed, false otherwise
     *         null if Gerrit does not support this attribute
     *
     * @deprecated use {@link #isUpdated()} instead.
     */
    @Deprecated
    public Boolean getUpdated() {
        return updated;
    }

    /**
     * The old (or previous) approval value.
     *
     * @return the old approval value.
     */
    public String getOldValue() {
        return oldValue;
    }

    /**
     * Checks whether this approval was updated.
     * oldValue is only set when the approval has been changed.
     *
     * @return true if approval was updated, otherwise false.
     */
    public Boolean isUpdated() {
        if (getOldValue() != null) {
          return true;
        }
        return false;
    }

    /**
     * Set the approval value.
     *
     * @param value the approval value.
     */
    public void setValue(String value) {
        this.value = value;
    }

    @Override
    public String toString() {
        return "Approval: " + getType() + " " + getValue();
    }

    @Override
    public int hashCode() {
        //CS IGNORE MagicNumber FOR NEXT 5 LINES. REASON: Autogenerated Code.
        //CS IGNORE AvoidInlineConditionals FOR NEXT 5 LINES. REASON: Autogenerated Code.
        final int prime = 31;
        int result = 1;
        result = prime * result + ((type == null) ? 0 : type.hashCode());
        result = prime * result + ((value == null) ? 0 : value.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        //CS IGNORE NeedBraces FOR NEXT 18 LINES. REASON: Autogenerated Code.
        //CS IGNORE NoWhitespaceAfter FOR NEXT 18 LINES. REASON: Autogenerated Code.
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        Approval other = (Approval) obj;
        if (type == null) {
            if (other.type != null)
                return false;
        } else if (!type.equals(other.type))
            return false;
        if (value == null) {
            if (other.value != null)
                return false;
        } else if (!value.equals(other.value))
            return false;
        return true;
    }

    /**
     * Converts old serialized data to newer construct.
     *
     * @return itself
     */
    @SuppressWarnings("unused")
    private Object readResolve() {
        if (username != null) {
            by = new Account();
            by.setUsername(username);
            username = null;
        }
        return this;
    }
}