com.github.klieber.phantomjs.util.VersionUtil.java Source code

Introduction

Here is the source code for com.github.klieber.phantomjs.util.VersionUtil.java

Source

/*
 * Copyright (c) 2015 Kyle Lieber
 *
 * 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.github.klieber.phantomjs.util;

import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.ComparableVersion;
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
import org.apache.maven.artifact.versioning.VersionRange;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class VersionUtil {

    private static final Logger LOGGER = LoggerFactory.getLogger(VersionUtil.class);

    public static int compare(String versionA, String versionB) {
        if (versionA == versionB) {
            return 0;
        }
        if (versionA == null) {
            return -1;
        }
        if (versionB == null) {
            return 1;
        }
        return new ComparableVersion(versionA).compareTo(new ComparableVersion(versionB));
    }

    public static boolean isGreaterThan(String versionA, String versionB) {
        return compare(versionA, versionB) > 0;
    }

    public static boolean isLessThan(String versionA, String versionB) {
        return compare(versionA, versionB) < 0;
    }

    public static boolean isGreaterThanOrEqualTo(String versionA, String versionB) {
        return !VersionUtil.isLessThan(versionA, versionB);
    }

    public static boolean isLessThanOrEqualTo(String versionA, String versionB) {
        return !VersionUtil.isGreaterThan(versionA, versionB);
    }

    public static boolean isEqualTo(String versionA, String versionB) {
        return compare(versionA, versionB) == 0;
    }

    public static int compare(ArtifactVersion versionA, ArtifactVersion versionB) {
        if (versionA == versionB) {
            return 0;
        }
        if (versionA == null) {
            return -1;
        }
        if (versionB == null) {
            return 1;
        }
        return versionA.compareTo(versionB);
    }

    public static boolean isGreaterThanOrEqualTo(ArtifactVersion versionA, ArtifactVersion versionB) {
        return !VersionUtil.isLessThan(versionA, versionB);
    }

    public static boolean isLessThan(ArtifactVersion versionA, ArtifactVersion versionB) {
        return compare(versionA, versionB) < 0;
    }

    public static boolean isLessThanOrEqualTo(ArtifactVersion versionA, ArtifactVersion versionB) {
        return !VersionUtil.isGreaterThan(versionA, versionB);
    }

    public static boolean isGreaterThan(ArtifactVersion versionA, ArtifactVersion versionB) {
        return compare(versionA, versionB) > 0;
    }

    public static boolean isWithin(String version, VersionRange versionRange) {
        ArtifactVersion artifactVersion = new DefaultArtifactVersion(version);
        ArtifactVersion recommendedVersion = versionRange.getRecommendedVersion();
        // treat recommended version as minimum version
        return recommendedVersion != null ? VersionUtil.isLessThanOrEqualTo(recommendedVersion, artifactVersion)
                : versionRange.containsVersion(artifactVersion);
    }

    public static boolean isWithin(String version, String versionSpec) {
        boolean within = false;
        try {
            return VersionUtil.isWithin(version, VersionRange.createFromVersionSpec(versionSpec));
        } catch (InvalidVersionSpecificationException e) {
            LOGGER.warn("Invalid version specification: {}", versionSpec);
        }
        return within;
    }
}