org.sonar.api.compat.internal.Version.java Source code

Introduction

Here is the source code for org.sonar.api.compat.internal.Version.java

Source

/*
 * SonarSource :: Update Center :: Common
 * Copyright (C) 2010 SonarSource
 * dev@sonar.codehaus.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.api.compat.internal;

import org.apache.commons.lang.StringUtils;

public class Version implements Comparable<Version> {

    private String normalizedMajor = normalizePart("0");
    private String normalizedMinor = normalizePart("0");
    private String normalizedPatch = normalizePart("0");
    private String normalizedPatch2 = normalizePart("0");
    private String major = "0";
    private String minor = "0";
    private String patch = "0";
    private String patch2 = "0";
    private String qualifier;
    private String name;

    private Version(String version) {
        this.name = StringUtils.trimToEmpty(version);
        this.qualifier = StringUtils.substringAfter(this.name, "-");
        String numbers = StringUtils.substringBefore(this.name, "-");
        String[] split = StringUtils.split(numbers, '.');
        if (split.length >= 1) {
            major = split[0];
            normalizedMajor = normalizePart(major);
        }
        if (split.length >= 2) {
            minor = split[1];
            normalizedMinor = normalizePart(minor);
        }
        if (split.length >= 3) {
            patch = split[2];
            normalizedPatch = normalizePart(patch);
        }
        if (split.length >= 4) {
            patch2 = split[3];
            normalizedPatch2 = normalizePart(patch2);
        }
    }

    private static String normalizePart(String part) {
        return StringUtils.leftPad(part, 4, '0');
    }

    public String getMajor() {
        return major;
    }

    public String getMinor() {
        return minor;
    }

    public String getPatch() {
        return patch;
    }

    public String getPatch2() {
        return patch2;
    }

    public String getName() {
        return name;
    }

    public String getQualifier() {
        return qualifier;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof Version)) {
            return false;
        }
        Version other = (Version) o;
        return normalizedMajor.equals(other.normalizedMajor) && normalizedMinor.equals(other.normalizedMinor)
                && normalizedPatch.equals(other.normalizedPatch) && normalizedPatch2.equals(other.normalizedPatch2)
                && qualifier.equals(other.qualifier);
    }

    @Override
    public int hashCode() {
        int result = normalizedMajor.hashCode();
        result = 31 * result + normalizedMinor.hashCode();
        result = 31 * result + normalizedPatch.hashCode();
        result = 31 * result + normalizedPatch2.hashCode();
        result = 31 * result + qualifier.hashCode();
        return result;
    }

    public int compareTo(Version other) {
        int c = compareToIgnoreQualifier(other);
        if (c == 0) {
            if ("".equals(qualifier)) {
                c = ("".equals(other.qualifier) ? 0 : 1);
            } else if ("".equals(other.qualifier)) {
                c = -1;
            } else {
                c = qualifier.compareTo(other.qualifier);
            }
        }
        return c;
    }

    public int compareToIgnoreQualifier(Version other) {
        int c = normalizedMajor.compareTo(other.normalizedMajor);
        if (c == 0) {
            c = normalizedMinor.compareTo(other.normalizedMinor);
            if (c == 0) {
                c = normalizedPatch.compareTo(other.normalizedPatch);
                if (c == 0) {
                    c = normalizedPatch2.compareTo(other.normalizedPatch2);
                }
            }
        }
        return c;
    }

    @Override
    public String toString() {
        return name;
    }

    public static Version create(String version) {
        return new Version(version);
    }

    /**
     * Creates a version without the qualifier part. For example 1.2.3-SNAPSHOT
     * and 2.0-RC1 are converted to 1.2.3 and 2.0.
     * @deprecated use {@link #removeQualifier()}
     */
    @Deprecated
    public static Version createRelease(String version) {
        return create(version).removeQualifier();
    }

    public static boolean isSnapshot(String version) {
        return StringUtils.endsWith(version, "SNAPSHOT");
    }

    public Version removeQualifier() {
        return new Version(StringUtils.substringBefore(this.toString(), "-"));
    }

    /**
     * Two versions are compatible when they are identical except for qualifier.
     */
    public boolean isCompatibleWith(Version version) {
        return this.removeQualifier().equals(version.removeQualifier());
    }
}