java.lang.Object
- io.microsphere.util.Version

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<Version>

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

Represents a version number composed of major, minor, and patch components.

This class provides methods to compare versions using standard comparison operators such as greater than, less than, and equal to. It also supports parsing version strings in the format "major.minor.patch". The supported version patterns :

major
major.minor
major.minor.patch
major.minor.patch-preRelease

See Semantic Versioning for more details.

Example Usage


 Version v1 = new Version(1, 2, 3);
 Version v2 = Version.of("1.2.3");

 // Comparison
 boolean isEqual = v1.equals(v2); // true
 boolean isGreaterThan = v1.isGreaterThan(Version.of("1.2.2")); // true
 boolean isLessThan = v1.lt(Version.of("1.3.0")); // true

 // Parsing from string
 Version v3 = Version.of("2.0.0");

 // Getting version from a class's manifest
 Version versionFromManifest = Version.getVersion(MyClass.class);

Since:: 1.0.0
Author:: Mercy
See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Version.Operator

Constructor Summary

Constructors
Constructor	Description
`Version(int major)`
`Version(int major, int minor)`
`Version(int major, int minor, int patch)`
`Version(int major, int minor, int patch, java.lang.String preRelease)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(Version that)`
`boolean`	`eq(Version that)`	Current `Version` is equal to that
`boolean`	`equals(Version that)`	Current `Version` is equal to that
`boolean`	`equals(java.lang.Object o)`	Current `Version` is equal to that
`boolean`	`ge(Version that)`	Current `Version` is greater than or equal to that
`int`	`getMajor()`	The major version
`int`	`getMinor()`	The minor version
`int`	`getPatch()`	The patch
`java.lang.String`	`getPreRelease()`	The pre-release
`static Version`	`getVersion(java.lang.Class<?> targetClass)`	Class that exposes the version.
`boolean`	`gt(Version that)`	Current `Version` is greater than that
`int`	`hashCode()`
`boolean`	`isGreaterOrEqual(Version that)`	Current `Version` is greater than or equal to that
`boolean`	`isGreaterThan(Version that)`	Current `Version` is greater than that
`boolean`	`isLessOrEqual(Version that)`	Current `Version` is less than or equal to that
`boolean`	`isLessThan(Version that)`	Current `Version` is less than that
`boolean`	`le(Version that)`	Current `Version` is less than or equal to that
`boolean`	`lt(Version that)`	Current `Version` is less than that
`static Version`	`of(int major)`
`static Version`	`of(int major, int minor)`
`static Version`	`of(int major, int minor, int patch)`
`static Version`	`of(int major, int minor, int patch, java.lang.String preRelease)`
`static Version`	`of(java.lang.String version)`
`static Version`	`ofVersion(int major)`
`static Version`	`ofVersion(int major, int minor)`
`static Version`	`ofVersion(int major, int minor, int patch)`
`static Version`	`ofVersion(int major, int minor, int patch, java.lang.String preRelease)`
`static Version`	`ofVersion(java.lang.String version)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Version
```
public Version(int major)
```
  - Version
```
public Version(int major,
               int minor)
```
  - Version
```
public Version(int major,
               int minor,
               int patch)
```
  - Version
```
public Version(int major,
               int minor,
               int patch,
               java.lang.String preRelease)
```
- Method Detail
  - getMajor
```
public int getMajor()
```
    The major version
    
    Returns:
    
    major version
  - getMinor
```
public int getMinor()
```
    The minor version
    
    Returns:
    
    minor version
  - getPatch
```
public int getPatch()
```
    The patch
    
    Returns:
    
    patch
  - getPreRelease
```
@Nullable
public java.lang.String getPreRelease()
```
    The pre-release
    
    Returns:
    
    pre-release
  - gt
```
public boolean gt(Version that)
```
    Current Version is greater than that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if greater than, or false
    
    See Also:
    
    isGreaterThan(Version)
  - isGreaterThan
```
public boolean isGreaterThan(Version that)
```
    Current Version is greater than that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if greater than, or false
    
    See Also:
    
    gt(Version)
  - ge
```
public boolean ge(Version that)
```
    Current Version is greater than or equal to that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if greater than, or false
    
    See Also:
    
    isGreaterOrEqual(Version)
  - isGreaterOrEqual
```
public boolean isGreaterOrEqual(Version that)
```
    Current Version is greater than or equal to that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if greater than, or false
    
    See Also:
    
    ge(Version)
  - lt
```
public boolean lt(Version that)
```
    Current Version is less than that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if less than, or false
  - isLessThan
```
public boolean isLessThan(Version that)
```
    Current Version is less than that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if less than, or false
  - le
```
public boolean le(Version that)
```
    Current Version is less than or equal to that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if less than, or false
    
    See Also:
    
    isLessOrEqual(Version)
  - isLessOrEqual
```
public boolean isLessOrEqual(Version that)
```
    Current Version is less than or equal to that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if less than, or false
    
    See Also:
    
    le(Version)
  - eq
```
public boolean eq(Version that)
```
    Current Version is equal to that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if equals, or false
  - equals
```
public boolean equals(Version that)
```
    Current Version is equal to that
    
    Parameters:
    
    that - the version to be compared
    
    Returns:
    
    true if equals, or false
  - equals
```
public boolean equals(java.lang.Object o)
```
    Current Version is equal to that
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the version to be compared
    
    Returns:
    
    true if equals, or false
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(Version that)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Version>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - of
```
public static Version of(int major)
```
  - of
```
public static Version of(int major,
                         int minor)
```
  - of
```
public static Version of(int major,
                         int minor,
                         int patch)
```
  - of
```
public static Version of(int major,
                         int minor,
                         int patch,
                         java.lang.String preRelease)
```
  - of
```
public static Version of(java.lang.String version)
```
  - ofVersion
```
public static Version ofVersion(int major)
```
  - ofVersion
```
public static Version ofVersion(int major,
                                int minor)
```
  - ofVersion
```
public static Version ofVersion(int major,
                                int minor,
                                int patch)
```
  - ofVersion
```
public static Version ofVersion(int major,
                                int minor,
                                int patch,
                                java.lang.String preRelease)
```
  - ofVersion
```
public static Version ofVersion(java.lang.String version)
```
  - getVersion
```
@Nonnull
public static Version getVersion(java.lang.Class<?> targetClass)
                          throws java.lang.IllegalArgumentException
```
    Class that exposes the version. Fetches the "Implementation-Version" manifest attribute from the jar file.
    
    Parameters:
    
    targetClass - the class to exposes the version
    
    Returns:
    
    non-null
    
    Throws:
    
    java.lang.IllegalArgumentException - if the "Implementation-Version" manifest attribute can't be fetched from the jar file.

Class Version

Example Usage

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Version

Version

Version

Version

Method Detail

getMajor

getMinor

getPatch

getPreRelease

gt

isGreaterThan

ge

isGreaterOrEqual

lt

isLessThan

le

isLessOrEqual

eq

equals

equals

hashCode

compareTo

toString

of

of

of

of

of

ofVersion

ofVersion

ofVersion

ofVersion

ofVersion

getVersion