com.g00fy2.versioncompare

Class Version

java.lang.Object

com.g00fy2.versioncompare.Version

All Implemented Interfaces:

java.lang.Comparable<Version>

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

Constructor Summary

Constructors

Constructor and Description
Version(java.lang.String versionString) Initializes a newly created Version object that represents the parsed version information.
Version(java.lang.String versionString, boolean throwExceptions) Initializes a newly created Version object that represents the parsed version information.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Version version)
boolean	equals(java.lang.Object o)
int	getMajor() Returns the major version.
int	getMinor() Returns the minor version.
java.lang.String	getOriginalString() Returns the initial string
int	getPatch() Returns the patch version.
java.util.List<java.lang.Integer>	getSubversionNumbers() Returns a list with all numeric version parts.
java.lang.String	getSuffix() Returns the suffix.
int	hashCode()
boolean	isAtLeast(java.lang.String otherVersion) Checks if the Version object is equal or higher than otherVersion.
boolean	isAtLeast(java.lang.String otherVersion, boolean ignoreSuffix) Checks if the Version object is equal or higher than otherVersion.
boolean	isAtLeast(Version otherVersion) Checks if the Version object is equal or higher than otherVersion.
boolean	isAtLeast(Version otherVersion, boolean ignoreSuffix) Checks if the Version object is equal or higher than otherVersion.
boolean	isEqual(java.lang.String otherVersion) Checks if the Version object is equal to otherVersion.
boolean	isEqual(Version otherVersion) Checks if the Version object is equal to otherVersion.
boolean	isHigherThan(java.lang.String otherVersion) Checks if the Version object is higher than otherVersion.
boolean	isHigherThan(Version otherVersion) Checks if the Version object is higher than otherVersion.
boolean	isLowerThan(java.lang.String otherVersion) Checks if the Version object is lower than otherVersion.
boolean	isLowerThan(Version otherVersion) Checks if the Version object is lower than otherVersion.

Methods inherited from class java.lang.Object

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

Constructor Detail

Version

public Version(@Nullable
               java.lang.String versionString)

Initializes a newly created Version object that represents the parsed version information. Will have default values if versionString could not get parsed.

Parameters:

versionString - the string representing the version.

See Also:

Version(String versionString, boolean throwExceptions)

Version

public Version(@Nullable
               java.lang.String versionString,
               boolean throwExceptions)

Initializes a newly created Version object that represents the parsed version information. Throws exceptions if throwExceptions is true and versionString could not get parsed.

Parameters:

versionString - the string representing the version.

throwExceptions - controls whether invalid versionString should cause exceptions.

Throws:

java.lang.NullPointerException - if versionString is null.

java.lang.IllegalArgumentException - if versionString does not start with a numeric character.

See Also:

Version(String versionString)

Method Detail

getMajor

public int getMajor()

Returns the major version.

Returns:

the major version, default 0.

getMinor

public int getMinor()

Returns the minor version.

Returns:

the minor version, default 0.

getPatch

public int getPatch()

Returns the patch version.

Returns:

the patch version, default 0.

getSubversionNumbers

@Nonnull
public java.util.List<java.lang.Integer> getSubversionNumbers()

Returns a list with all numeric version parts.

Returns:

a list with all numeric version parts found, default empty.

getSuffix

@Nonnull
public java.lang.String getSuffix()

Returns the suffix.

Returns:

the suffix (first non-numeric part), default empty.

getOriginalString

@Nullable
public java.lang.String getOriginalString()

Returns the initial string

Returns:

the unmodified initial string.

isHigherThan

public boolean isHigherThan(java.lang.String otherVersion)

Checks if the Version object is higher than otherVersion.

Parameters:

otherVersion - a string representing another version.

Returns:

true if Version object is higher than otherVersion or otherVersion could not get parsed. False if the Version is lower or equal.

See Also:

isHigherThan(Version otherVersion)

isHigherThan

public boolean isHigherThan(Version otherVersion)

Checks if the Version object is higher than otherVersion.

Parameters:

otherVersion - a Version object representing another version.

Returns:

true if Version object is higher than otherVersion or otherVersion could not get parsed. False if the Version is lower or equal.

See Also:

isHigherThan(String otherVersion)

isLowerThan

public boolean isLowerThan(java.lang.String otherVersion)

Checks if the Version object is lower than otherVersion.

Parameters:

otherVersion - a string representing another version.

Returns:

true if Version object is lower than otherVersion. False if the Version is higher, equal or otherVersion could not get parsed.

See Also:

isLowerThan(Version otherVersion)

isLowerThan

public boolean isLowerThan(Version otherVersion)

Checks if the Version object is lower than otherVersion.

Parameters:

otherVersion - a Version object representing another version.

Returns:

true if Version object is lower than otherVersion. False if the Version is higher, equal or otherVersion could not get parsed.

See Also:

isLowerThan(String otherVersion)

isEqual

public boolean isEqual(java.lang.String otherVersion)

Checks if the Version object is equal to otherVersion.

Parameters:

otherVersion - a string representing another version.

Returns:

true if Version object and otherVersion are logically equal. False if the Version is higher, lower or otherVersion could not get parsed.

See Also:

isEqual(Version otherVersion)

isEqual

public boolean isEqual(Version otherVersion)

Checks if the Version object is equal to otherVersion.

Parameters:

otherVersion - a Version object representing another version.

Returns:

true if Version object and otherVersion are logically equal. False if the Version is higher, lower or otherVersion could not get parsed.

See Also:

isEqual(String otherVersion)

isAtLeast

public boolean isAtLeast(java.lang.String otherVersion)

Checks if the Version object is equal or higher than otherVersion.

Parameters:

otherVersion - a string representing another version.

Returns:

true if the version is equal or higher than otherVersion. False if the version is lower than otherVersion.

See Also:

isAtLeast(Version otherVersion)

isAtLeast

public boolean isAtLeast(Version otherVersion)

Checks if the Version object is equal or higher than otherVersion.

Parameters:

otherVersion - a Version object representing another version.

Returns:

true if the version is equal or higher than otherVersion. False if the version is lower than otherVersion.

See Also:

isAtLeast(String otherVersion)

isAtLeast

public boolean isAtLeast(java.lang.String otherVersion,
                         boolean ignoreSuffix)

Checks if the Version object is equal or higher than otherVersion.

Parameters:

otherVersion - a string representing another version.

ignoreSuffix - controls whether suffixes should be ignored.

Returns:

true if the version is equal or higher than otherVersion. False if the version is lower than otherVersion.

See Also:

isAtLeast(Version otherVersion, boolean ignoreSuffix)

isAtLeast

public boolean isAtLeast(Version otherVersion,
                         boolean ignoreSuffix)

Checks if the Version object is equal or higher than otherVersion.

Parameters:

otherVersion - a Version object representing another version.

ignoreSuffix - controls whether suffixes should be ignored.

Returns:

true if the version is equal or higher than otherVersion. False if the version is lower than otherVersion.

See Also:

isAtLeast(String otherVersion, boolean ignoreSuffix)

compareTo

public final int compareTo(@Nonnull
                           Version version)

Specified by:

compareTo in interface java.lang.Comparable<Version>

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object