com.communote.common.util

Class VersionComparator

java.lang.Object

com.communote.common.util.VersionComparator

All Implemented Interfaces:

Comparator<String>

public class VersionComparator
extends Object
implements Comparator<String>

Comparator to compare versions in dot notation like 3.25.2 as used in semantic versioning. The last part can be interpreted as revision.
Examples

• compare(1.0, 1.0.1) returns a value < 0
• compare(1.0.1, 1.0.1) returns 0
• compare(1.0.1, 1.0) returns a value > 0

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
VersionComparator() Default constructor which creates a comparator that is not revision aware.
VersionComparator(boolean versionEndsWithRevision, boolean numericIncreasingRevision) Constructor to fine-tune the handling of a revision in the version string

Method Summary

Modifier and Type	Method and Description
int	compare(String version1, String version2) Compares the version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

VersionComparator

public VersionComparator()

Default constructor which creates a comparator that is not revision aware.

VersionComparator

public VersionComparator(boolean versionEndsWithRevision,
                         boolean numericIncreasingRevision)

Constructor to fine-tune the handling of a revision in the version string

Parameters:

versionEndsWithRevision - If true, the last part of the version is always interpreted as revision

numericIncreasingRevision - if versionEndsWithRevision is true, this parameter defines whether the revision is a numeric value which increases with every new revision. Only in this case the revision is compared.

Since:

3.5

Method Detail

compare

public int compare(String version1,
                   String version2)

Compares the version.

Specified by:

compare in interface Comparator<String>

Parameters:

version1 - the version1 (e.g. 1.0.1)

version2 - the version2 (e.g 1.0)

Returns:

a value greater 0 if version1 > version2
0 if version1 == version2
a value less 0 if version1 < version2