Version Comparator

Version Comparator is an ultra-micro library written in java that lets you compare version numbers.

Latest Version 1.1.1

Requirements

• Minimum Java version: 8
• Minimum Android version: 5.0 minSdkVersion 21

Main features

• Micro library (~25k jar)
• Absolutely trivial to use
• No external dependencies
• The code is clean, testable, compact and very easy to understand and maintain
• Completely covered with a large number of unit tests
• Easily extendable

Goals

• Provide a simple-to-use library to simplify version comparison
• Make the code as clean and testable as possible
• Don't rely on any other third-party library except for standard Java libraries
• Obtain a jar as small as possible
• Write good documentation for the library usage

How to add Version Comparator dependency in your project

Gradle:

dependencies {
    implementation "it.rebirthproject:version-comparator:1.1.1"
}

Maven:

<dependency>
    <groupId>it.rebirthproject</groupId>
    <artifactId>version-comparator</artifactId>
    <version>1.1.1</version>
</dependency>

Introduction

The version comparator can compare versions provided in string format. Currently, the library checks whether a passed version conforms to the internal parser rules. It throws an exception if an invalid version is provided as input. The library in its current state of the art has three different parsers to choose from:

1. a minimal parser (version format X.Y.Z)
2. a semantic version parser (the standard semantic version you can find here https://semver.org/, that basically parses this version format X.Y.Z-QUALIFIER+buildmetadata)
3. a relaxed semantic version parser that is the default choice to build the comparator and is basically the version standard used by Maven artifacts (version format X.Y.Z-QUALIFIER where the qualifier should be a unique type string). The qualifier types recognized by the relaxed parser are the following and in this order of priority:

• SNAPSHOT
• PRE_ALPHA
• ALPHA
• BETA
• MILESTONE
• RC
• STABLE
• FINAL

4. a complete Maven's rules compliant version parser (you can find here the specs https://maven.apache.org/pom.html#version-order-specification)

Usage

//create a default relaxed semantic version comparator
//version to check is in this format X.Y.Z-QUALIFIER
VersionComparator vc = new VersionComparatorBuilder().build();

//create a minimal version comparator 
//version to check is in this format X.Y.Z
VersionComparator vc = new VersionComparatorBuilder().useMinimalVersionParser().build();

//create a semantic version comparator (https://semver.org/)
//version to check is in this format X.Y.Z-QUALIFIER+buildmetadata
VersionComparator vc = new VersionComparatorBuilder().useStrictSemanticVersionParser().build();

//create a maven's rules version comparator (https://maven.apache.org/pom.html#version-order-specification)
//version to check is in different formats as stated by the maven's document. For example: 1-1.foo-bar1baz-.1 
VersionComparator vc = new VersionComparatorBuilder().useMavenRulesVersionParser().build();

//use the version comparator
try {     
    int comp1=vc.compare("1.0.0-FINAL", "1.0.0-RC");
    int comp2=vc.compare("1.0.0", "1.0.1");
    int comp3=vc.compare("1.0.0-FINAL+build2024", "1.0.0-RC+build2023");
    int comp4=vc.compare("1-1.foo-bar1baz-.1", "1-1.bar");
} catch (IllegalArgumentException ex) {
    //Do something here in case of exception
}

Contributors

If you would like to help, but don't know where to start, please note that finding bugs and debugging the code is always a good start. Simple Pull Requests that fix anything other than Version Comparator core code (documentation, JavaDoc, typos, test cases, etc) are always appreciated and would be merged quickly. However, if you want or feel the need to change the main code or add a new functionality, please do not issue a pull request without creating a new issue and discussing your desired changes, before you start working on it. It would be a shame to reject your pull request if it might not align with the project's goals, design expectations or planned functionality.

For direct communications, you can use this email

Credits and License

Copyright (C) 2024 Andrea Paternesi

Copyright (C) 2024 Matteo Veroni

Current website under creation Rebirth Project

Version Comparator binaries and source code can be used according to the Apache License, Version 2.0.