org.zanata.rest.dto.VersionInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zanata-common-api Show documentation
Zanata API definitions
There is a newer version: 4.6.2
package org.zanata.rest.dto;

import java.io.Serializable;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import com.webcohesion.enunciate.metadata.DocumentationExample;
import com.webcohesion.enunciate.metadata.Label;
import org.codehaus.jackson.annotate.JsonIgnoreProperties;
import org.codehaus.jackson.annotate.JsonTypeName;
import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.zanata.common.Namespaces;

/**
 * Holds system version information
 */
@XmlRootElement(name = "versionInfo")
@XmlType(name = "versionType", propOrder = { "versionNo", "buildTimeStamp", "scmDescribe" })
@JsonTypeName(value = "versionType")
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)
@Label("Version Info")
public final class VersionInfo implements Serializable {
    private static final long serialVersionUID = 1L;
    private String versionNo;
    private String buildTimeStamp;
    private String scmDescribe;

    public VersionInfo(String versionNo, String buildTimestamp, String scmDescribe) {
        this.versionNo = versionNo;
        this.buildTimeStamp = buildTimestamp;
        this.scmDescribe = scmDescribe;
    }

    @Deprecated
    public VersionInfo(String versionNo, String buildTimestamp) {
        this(versionNo, buildTimestamp, "UNKNOWN");
    }

    public VersionInfo() {
    }

    public VersionInfo(VersionInfo other) {
        this(other.versionNo, other.buildTimeStamp, other.scmDescribe);
    }

    /**
     * Version number
     */
    @XmlElement(name = "versionNo", namespace = Namespaces.ZANATA_OLD)
    @DocumentationExample("4.0.0")
    public String getVersionNo() {
        return versionNo;
    }

    /**
     * ISO8601 timestamp for when the current system version was built
     */
    @XmlElement(name = "buildTimeStamp", namespace = Namespaces.ZANATA_OLD)
    @DocumentationExample("20170225-1448")
    public String getBuildTimeStamp() {
        return buildTimeStamp;
    }

    /**
     * Identifier for the current version in source control
     */
    @XmlElement(name = "scmDescribe", namespace = Namespaces.ZANATA_API)
    public String getScmDescribe() {
        return scmDescribe;
    }

    public void setVersionNo(String versionNo) {
        this.versionNo = versionNo;
    }

    public void setBuildTimeStamp(String buildTimestamp) {
        this.buildTimeStamp = buildTimestamp;
    }

    public void setScmDescribe(String scmDescribe) {
        this.scmDescribe = scmDescribe;
    }

    @Override
    public String toString() {
        return DTOUtil.toXML(this);
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result =
                prime
                        * result
                        + ((buildTimeStamp == null) ? 0 : buildTimeStamp
                                .hashCode());
        result =
                prime
                        * result
                        + ((scmDescribe == null) ? 0 : scmDescribe
                                .hashCode());
        result =
                prime * result
                        + ((versionNo == null) ? 0 : versionNo.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof VersionInfo)) {
            return false;
        }
        VersionInfo other = (VersionInfo) obj;
        if (buildTimeStamp == null) {
            if (other.buildTimeStamp != null) {
                return false;
            }
        } else if (!buildTimeStamp.equals(other.buildTimeStamp)) {
            return false;
        }
        if (scmDescribe == null) {
            if (other.scmDescribe != null) {
                return false;
            }
        } else if (!scmDescribe.equals(other.scmDescribe)) {
            return false;
        }
        if (versionNo == null) {
            if (other.versionNo != null) {
                return false;
            }
        } else if (!versionNo.equals(other.versionNo)) {
            return false;
        }
        return true;
    }

}