com.imsweb.validation.entities.ValidatorVersion Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2011 Information Management Services, Inc.
 */
package com.imsweb.validation.entities;

import java.util.Objects;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;

/**
 * This class encapsulates the notion of "version" for a validator, providing comparison features.
 * 
 * A version has a strict format composed of three parts separated by dashes:
 * 

 * A prefix that is not taken into account when comparing two versions
 * A three digits (left 0-padded) major release number
 * A two digits (left 0-padded) minor release number
 * 
 * An example of a version would then be SE12-001-01.
 * 
 * Created on Feb 23, 2011 by depryf
 */
public class ValidatorVersion implements Comparable {

    /**
     * The raw representation of the version
     */
    protected String _rawString;

    /**
     * Prefix part
     */
    protected String _prefix;

    /**
     * Major number part
     */
    protected Integer _major;

    /**
     * Minor number part
     */
    protected Integer _minor;

    /**
     * Minor suffix part
     */
    protected Integer _suffix;

    /**
     * Constructor.
     * 

     * Created on Feb 23, 2011 by depryf
     */
    public ValidatorVersion(String rawString) {
        if (!validateVersionFormat(rawString))
            throw new IllegalStateException("provided raw version does not have a valid format: " + rawString);

        String[] parts = StringUtils.split(rawString, '-');

        _rawString = rawString;
        _prefix = parts[0];
        _major = Integer.valueOf(parts[1]);
        _minor = Integer.valueOf(parts[2]);
        if (parts.length == 4)
            _suffix = Integer.valueOf(parts[3]);
        else
            _suffix = 0;
    }

    /**
     * Getter.
     * 

     * Created on Feb 23, 2011 by depryf
     * @return raw representation of this version
     */
    public String getRawString() {
        return _rawString;
    }

    /**
     * Getter.
     * 

     * Created on Feb 23, 2011 by depryf
     * @return prefix part
     */
    public String getPrefix() {
        return _prefix;
    }

    /**
     * Getter.
     * 

     * Created on Feb 23, 2011 by depryf
     * @return major part
     */
    public Integer getMajor() {
        return _major;
    }

    /**
     * Getter.
     * 

     * Created on Feb 23, 2011 by depryf
     * @return minor part
     */
    public Integer getMinor() {
        return _minor;
    }

    /**
     * Getter.
     * 

     * Created on Feb 23, 2011 by depryf
     * @return suffix part
     */
    public Integer getSuffix() {
        return _suffix;
    }

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

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof ValidatorVersion)) return false;
        ValidatorVersion that = (ValidatorVersion)o;
        return Objects.equals(_major, that._major) &&
                Objects.equals(_minor, that._minor) &&
                Objects.equals(_suffix, that._suffix);
    }

    @Override
    public int hashCode() {

        return Objects.hash(_major, _minor, _suffix);
    }

    @Override
    public int compareTo(ValidatorVersion o) {
        int comp = getMajor().compareTo(o.getMajor());
        if (comp != 0)
            return comp;
        comp = getMinor().compareTo(o.getMinor());
        if (comp != 0)
            return comp;
        return getSuffix().compareTo(o.getSuffix());
    }

    /**
     * Validates the provided raw version.
     * 

     * Created on Feb 23, 2011 by depryf
     * @param rawVersion raw version
     * @return true if it has a valid format, false otherwise.
     */
    public static boolean validateVersionFormat(String rawVersion) {
        if (rawVersion == null)
            return false;

        String[] parts = StringUtils.split(rawVersion, '-');
        if (parts.length == 3)
            return NumberUtils.isDigits(parts[1]) && parts[1].length() == 3 && NumberUtils.isDigits(parts[2]) && parts[2].length() == 2;
        if (parts.length == 4)
            return NumberUtils.isDigits(parts[1]) && parts[1].length() == 3 && NumberUtils.isDigits(parts[2]) && parts[2].length() == 2 && NumberUtils.isDigits(parts[3]) && parts[3].length() == 1;
        return false;
    }

    /**
     * Compares the two raw versions; if one of them is null or does not have a proper format, it will be considered as earlier (older).
     * 
     * Created on Feb 23, 2011 by depryf
     * @param rawVersion1 left-side raw version
     * @param rawVersion2 right-side raw versiohn
     * @return comparison results (negative, 0 or positive)
     */
    public static int compareVersions(String rawVersion1, String rawVersion2) {
        if (!validateVersionFormat(rawVersion1))
            return -1;
        if (!validateVersionFormat(rawVersion2))
            return 1;
        return new ValidatorVersion(rawVersion1).compareTo(new ValidatorVersion(rawVersion2));
    }
}