com.peterphi.std.types

Class Version

java.lang.Object

com.peterphi.std.types.Version

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Version>

public class Version
extends java.lang.Object
implements java.lang.Comparable<Version>, java.io.Serializable

Title: Version

Description: Provides a structured, validated and comparable way of representing a version

Copyright: Copyright (c) 2006-2010

Version:

$Revision$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Version	MAX_VALUE
static Version	MIN_VALUE

Constructor Summary

Constructors

Constructor and Description
Version() Deprecated. DO NOT USE THIS METHOD - FOR BEAN SERIALISER ONLY. CREATES INVALID VERSIONS
Version(int... vers)
Version(java.lang.String versionString) Constructs a new version.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Version vers)
boolean	equals(java.lang.Object o)
int[]	getContent() Deprecated. DO NOT USE THIS METHOD - FOR BEAN SERIALISER ONLY
int	getField(int index) Retrieves the given field from this Version
int	getField(int index, int defaultValue) Retrieves the given field from this Version
int	hashCode() Produces a fairly unreliable hashCode (eg.
static boolean	overlapping(Version min1, Version max1, Version min2, Version max2) Determines if 2 version ranges have any overlap
static Version	parseStringComparable(java.lang.String version)
void	setContent(int[] content) Deprecated. DO NOT USE THIS METHOD - FOR BEAN SERIALISER ONLY
java.lang.String	toComparableString()
java.lang.String	toString()
boolean	within(Version min, Version max) Tests (inclusively) whether this version is within a given range

Methods inherited from class java.lang.Object

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

Field Detail

MIN_VALUE

public static final Version MIN_VALUE

MAX_VALUE

public static final Version MAX_VALUE

Constructor Detail

Version

public Version(java.lang.String versionString)

Constructs a new version.

Parameters:

versionString - String The version string (eg. "1.2.3"). it MUST have at least ONE digit and match the regex ^(min|max|([0-9]+\.)*[0-9]+(\.(max|min))?)$

Version

public Version(int... vers)

Version

@Deprecated
public Version()

Deprecated. DO NOT USE THIS METHOD - FOR BEAN SERIALISER ONLY. CREATES INVALID VERSIONS

Method Detail

getField

public int getField(int index,
           int defaultValue)

Retrieves the given field from this Version

Parameters:

index - int The index to retrieve (based at 0)

defaultValue - int The default value to return if the index doesn't exist

Returns:

int The value of the version segment

getField

public int getField(int index)

Retrieves the given field from this Version

Parameters:

index - int The index to retrieve (based at 0)

Returns:

int The value of the version segment

Throws:

java.lang.IllegalArgumentException - When the specified index is invalid

within

public boolean within(Version min,
             Version max)

Tests (inclusively) whether this version is within a given range

Parameters:

min - Version

max - Version

Returns:

boolean

overlapping

public static boolean overlapping(Version min1,
                  Version max1,
                  Version min2,
                  Version max2)

Determines if 2 version ranges have any overlap

Parameters:

min1 - Version The 1st range

max1 - Version The 1st range

min2 - Version The 2nd range

max2 - Version The 2nd range

Returns:

boolean True if the version ranges overlap

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Version vers)

Specified by:

compareTo in interface java.lang.Comparable<Version>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Produces a fairly unreliable hashCode (eg. 1.0 and 1.0.0 are identical but 1.2 and 2.1 are also identical) by adding the version bits together

Overrides:

hashCode in class java.lang.Object

getContent

@Deprecated
public int[] getContent()

Deprecated. DO NOT USE THIS METHOD - FOR BEAN SERIALISER ONLY

Returns:

int[] The version segments as an integer array (where Integer.MAX_VALUE means "max")

setContent

@Deprecated
public void setContent(int[] content)

Deprecated. DO NOT USE THIS METHOD - FOR BEAN SERIALISER ONLY

Parameters:

content - int[] A version as an integer array representing the segments (where Integer.MAX_VALUE means "max")

toComparableString

public java.lang.String toComparableString()

parseStringComparable

public static Version parseStringComparable(java.lang.String version)