Package org.apache.maven.artifact.versioning

Class ComparableVersion

java.lang.Object

org.apache.maven.artifact.versioning.ComparableVersion

All Implemented Interfaces:

java.lang.Comparable<ComparableVersion>

public class ComparableVersion
extends java.lang.Object
implements java.lang.Comparable<ComparableVersion>

Generic implementation of version comparison.

Features:

• mixing of '-' (hyphen) and '.' (dot) separators,
• transition between characters and digits also constitutes a separator: 1.0alpha1 => [1, 0, alpha, 1]
• unlimited number of version components,
• version components in the text can be digits or strings,
• strings are checked for well-known qualifiers and the qualifier ordering is used for version ordering. Well-known qualifiers (case insensitive) are:
  • alpha or a
  • beta or b
  • milestone or m
  • rc or cr
  • snapshot
  • (the empty string) or ga or final
  • sp
  Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive),
• a hyphen usually precedes a qualifier, and is always less important than something preceded with a dot.

See Also:

"Versioning" on Maven Wiki

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ComparableVersion.BigIntegerItem	Represents a numeric item in the version item list.
private static class	ComparableVersion.IntItem	Represents a numeric item in the version item list that can be represented with an int.
private static interface	ComparableVersion.Item
private static class	ComparableVersion.ListItem	Represents a version list item.
private static class	ComparableVersion.LongItem	Represents a numeric item in the version item list that can be represented with a long.
private static class	ComparableVersion.StringItem	Represents a string in the version item list, usually a qualifier.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	canonical
private ComparableVersion.ListItem	items
private static int	MAX_INTITEM_LENGTH
private static int	MAX_LONGITEM_LENGTH
private java.lang.String	value

Constructor Summary

Constructors

Constructor	Description
ComparableVersion(java.lang.String version)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ComparableVersion o)
boolean	equals(java.lang.Object o)
java.lang.String	getCanonical()
int	hashCode()
static void	main(java.lang.String... args)	Main to test version parsing and comparison.
private static ComparableVersion.Item	parseItem(boolean isDigit, java.lang.String buf)
void	parseVersion(java.lang.String version)
private static java.lang.String	stripLeadingZeroes(java.lang.String buf)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAX_INTITEM_LENGTH

private static final int MAX_INTITEM_LENGTH

See Also:

Constant Field Values

MAX_LONGITEM_LENGTH

private static final int MAX_LONGITEM_LENGTH

See Also:

Constant Field Values

value

private java.lang.String value

canonical

private java.lang.String canonical

items

private ComparableVersion.ListItem items

Constructor Detail

ComparableVersion

public ComparableVersion(java.lang.String version)

Method Detail

parseVersion

public final void parseVersion(java.lang.String version)

parseItem

private static ComparableVersion.Item parseItem(boolean isDigit,
                                                java.lang.String buf)

stripLeadingZeroes

private static java.lang.String stripLeadingZeroes(java.lang.String buf)

compareTo

public int compareTo(ComparableVersion o)

Specified by:

compareTo in interface java.lang.Comparable<ComparableVersion>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCanonical

public java.lang.String getCanonical()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

main

public static void main(java.lang.String... args)

Main to test version parsing and comparison.

To check how "1.2.7" compares to "1.2-SNAPSHOT", for example, you can issue

java -jar ${maven.repo.local}/org/apache/maven/maven-artifact/${maven.version}/maven-artifact-${maven.version}.jar "1.2.7" "1.2-SNAPSHOT"

command to command line. Result of given command will be something like this:

 Display parameters as parsed by Maven (in canonical form) and comparison result:
 1. 1.2.7 == 1.2.7
    1.2.7 > 1.2-SNAPSHOT
 2. 1.2-SNAPSHOT == 1.2-snapshot
 

Parameters:

args - the version strings to parse and compare. You can pass arbitrary number of version strings and always two adjacent will be compared