com.mgnt.utils.textutils

Class VersionRange

java.lang.Object

com.mgnt.utils.textutils.VersionRange

All Implemented Interfaces:

java.io.Serializable

public class VersionRange
extends java.lang.Object
implements java.io.Serializable

This class represents a Version Range. It has the lower and upper limits and allows to check if a version is within range or not and if two ranges overlap or not

Author:

Michael Gantman

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VersionRange(java.lang.String versionRange) This constructor assumes that the string is a version range in format "[Version String] - [Version String]" It splits the string by the "-" delimiter and attempts to create the range the same way as constructor VersionRange(String, String) would.
VersionRange(java.lang.String fromVersion, java.lang.String toVersion) This constructor constructs the Range with its lower and upper limits.
VersionRange(java.lang.String fromVersion, Version toVersion) This constructor constructs the Range with its lower and upper limits.
VersionRange(Version ver) This constructor creates the Range with the same lower and upper limits
VersionRange(Version fromVersion, java.lang.String toVersion) This constructor constructs the Range with its lower and upper limits.
VersionRange(Version fromVersion, Version toVersion) This constructor constructs the Range with its lower and upper limits

Method Summary

Modifier and Type	Method and Description
Version	getFromVersion()
Version	getToVersion()
boolean	isAboveRange(java.lang.String ver) Converts the String into Version and than checks if the ver is above the range
boolean	isAboveRange(Version ver) Checks if the ver is above the range
boolean	isBellowRange(Version ver) Checks if the ver is below the range
boolean	isBelowRange(java.lang.String ver) Converts the String into Version and than checks if the ver is below the range
boolean	isInRange(java.lang.String ver) This method first converts String parameter into Version and checks if the version falls within range.
boolean	isInRange(Version ver) This method checks if the version falls within range.
boolean	isOverlap(VersionRange otherRange)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VersionRange

public VersionRange(Version fromVersion,
                    Version toVersion)
             throws InvalidVersionRangeException

This constructor constructs the Range with its lower and upper limits

Parameters:

fromVersion - Version that contains lower limit of the range

toVersion - Version that contains upper limit of the range

Throws:

InvalidVersionRangeException - if lower limit of the range is greater than upper limit

VersionRange

public VersionRange(java.lang.String fromVersion,
                    java.lang.String toVersion)
             throws InvalidVersionRangeException,
                    InvalidVersionFormatException

This constructor constructs the Range with its lower and upper limits. It first converts String parameters into Version values

Parameters:

fromVersion - String that contains lower limit of the range

toVersion - String that contains upper limit of the range

Throws:

InvalidVersionRangeException - if lower limit of the range is greater than upper limit

InvalidVersionFormatException - if one of the Strings is not a valid version

VersionRange

public VersionRange(Version fromVersion,
                    java.lang.String toVersion)
             throws InvalidVersionRangeException,
                    InvalidVersionFormatException

This constructor constructs the Range with its lower and upper limits. It first converts String parameter into Version value

Parameters:

fromVersion - String that contains lower limit of the range

toVersion - String that contains upper limit of the range

Throws:

InvalidVersionRangeException - if lower limit of the range is greater than upper limit

InvalidVersionFormatException - if String parameter is not a valid version

VersionRange

public VersionRange(java.lang.String fromVersion,
                    Version toVersion)
             throws InvalidVersionRangeException,
                    InvalidVersionFormatException

This constructor constructs the Range with its lower and upper limits. It first converts String parameter into Version value

Parameters:

fromVersion - String that contains lower limit of the range

toVersion - String that contains upper limit of the range

Throws:

InvalidVersionRangeException - if lower limit of the range is greater than upper limit

InvalidVersionFormatException - if String parameter is not a valid version

VersionRange

public VersionRange(Version ver)
             throws InvalidVersionRangeException

This constructor creates the Range with the same lower and upper limits

Parameters:

ver - String that holds a single version

Throws:

InvalidVersionRangeException - if parameter is null

VersionRange

public VersionRange(java.lang.String versionRange)
             throws InvalidVersionRangeException,
                    InvalidVersionFormatException

This constructor assumes that the string is a version range in format "[Version String] - [Version String]" It splits the string by the "-" delimiter and attempts to create the range the same way as constructor VersionRange(String, String) would. If the original String contains only one version without a delimiter (i.e. "[Version String]") the attempt is made to convert this String into single Version object and than to create VersionRange with the same lower and upper limits

Parameters:

versionRange - String in format "[Version String] - [Version String]" or "[Version String]"

Throws:

InvalidVersionRangeException - if lower limit of the range is greater than upper limit

InvalidVersionFormatException - if String parameter is not a valid version

Method Detail

getFromVersion

public Version getFromVersion()

Returns:

Version which is lower range limit

getToVersion

public Version getToVersion()

Returns:

Version which is upper range limit

isInRange

public boolean isInRange(Version ver)

This method checks if the version falls within range. Null version is always out of range and the comparison is all inclusive

Parameters:

ver - Version to be checked

Returns:

true if Version falls within range and false otherwise

isInRange

public boolean isInRange(java.lang.String ver)
                  throws InvalidVersionFormatException

This method first converts String parameter into Version and checks if the version falls within range. Null version is always out of range and the comparison is all inclusive

Parameters:

ver - String that contains Version value to be checked

Returns:

true if Version falls within range and false otherwise

Throws:

InvalidVersionFormatException - if String is not a valid version value

isAboveRange

public boolean isAboveRange(Version ver)

Checks if the ver is above the range

Parameters:

ver - Version to be checked

Returns:

true if version is above range false otherwise

isAboveRange

public boolean isAboveRange(java.lang.String ver)
                     throws InvalidVersionFormatException

Converts the String into Version and than checks if the ver is above the range

Parameters:

ver - String to be checked

Returns:

true if version is above range false otherwise

Throws:

InvalidVersionFormatException

isBellowRange

public boolean isBellowRange(Version ver)

Checks if the ver is below the range

Parameters:

ver - Version to be checked

Returns:

true if version is below range false otherwise

isBelowRange

public boolean isBelowRange(java.lang.String ver)
                     throws InvalidVersionFormatException

Converts the String into Version and than checks if the ver is below the range

Parameters:

ver - String to be checked

Returns:

true if version is bellow range false otherwise

Throws:

InvalidVersionFormatException

isOverlap

public boolean isOverlap(VersionRange otherRange)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object