com.atlassian.plugin.util

Class VersionStringComparator

java.lang.Object

com.atlassian.plugin.util.VersionStringComparator

All Implemented Interfaces:

Comparator<String>

public class VersionStringComparator
extends Object
implements Comparator<String>

Compares dotted version strings of varying length. Makes a best effort with other delimiters and non-numeric versions.

For dotted decimals, comparison is as you'd expect: 0.1 is before 0.2 is before 1.0 is before 2.0. This works for any number of dots.

More complicated version numbers are compared by splitting the version strings into components using the DELIMITER_PATTERN and comparing each component in order. The first difference found when comparing components left-to-right is returned.

Two numeric components (containing only digits) are compared as integers. A numeric component comes after any non-numeric one. Two non-numeric components are ordered by String.compareToIgnoreCase(String).

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_PATTERN
static String	DELIMITER_PATTERN
static Pattern	SNAPSHOT_PATTERN
static String	VALID_VERSION_PATTERN

Constructor Summary

Constructors

Constructor and Description
VersionStringComparator()

Method Summary

Modifier and Type	Method and Description
int	compare(String version1, String version2) Compares two version strings using the algorithm described above.
static boolean	isSnapshotVersion(String version)
static boolean	isValidVersionString(String 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

Field Detail

DELIMITER_PATTERN

public static final String DELIMITER_PATTERN

See Also:

Constant Field Values

COMPONENT_PATTERN

public static final String COMPONENT_PATTERN

See Also:

Constant Field Values

VALID_VERSION_PATTERN

public static final String VALID_VERSION_PATTERN

See Also:

Constant Field Values

SNAPSHOT_PATTERN

public static final Pattern SNAPSHOT_PATTERN

Constructor Detail

VersionStringComparator

public VersionStringComparator()

Method Detail

isValidVersionString

public static boolean isValidVersionString(String version)

isSnapshotVersion

public static boolean isSnapshotVersion(String version)

compare

public int compare(String version1,
                   String version2)

Compares two version strings using the algorithm described above.

Specified by:

compare in interface Comparator<String>

Returns:

-1 if version1 is before version2, 1 if version2 is before version1, or 0 if the versions are equal.

Throws:

IllegalArgumentException - if either argument does not match VALID_VERSION_PATTERN.

See Also:

isValidVersionString(String)