VersionNumber (nf-commons 20.01.0-edge API)

nextflow.util.VersionNumber

All Implemented Interfaces and Traits:

java.lang.Comparable
```
@groovy.transform.CompileStatic
class VersionNumber
extends java.lang.Object
```
Model a semantic version number
Authors:
Paolo Di Tommaso

Constructor Summary

Constructors
Constructor and description
`VersionNumber (java.lang.String str)` Create a version number object

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`compareTo(java.lang.Object obj)` Implements version number comparator logic
	`boolean`	`equals(java.lang.Object other)`
	`java.lang.String`	`getAt(int i)` Retrieve the i-th component in a version number
	`java.lang.String`	`getMajor()` @return The major version number ie. the first component
	`java.lang.String`	`getMinor()` @return The minor version number ie. the second component
	`java.lang.String`	`getPatch()` @return The minor version number ie. the third component
	`int`	`hashCode()`
	`boolean`	`matches(java.lang.String condition)` Checks if the version number satisfies the specified condition.
	`int`	`size()` @return The number of components in the version number eg `new VersionNumber('2.3.12').size() == 3`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - VersionNumber(java.lang.String str)
    
    Create a version number object
    Parameters:
    str - A dot separated version number string eg 2.3.12
- Method Detail
  - @java.lang.Override int compareTo(java.lang.Object obj)
    
    Implements version number comparator logic
    Parameters:
    o - the object to be compared.
    Returns:
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  - @java.lang.Override boolean equals(java.lang.Object other)
  - java.lang.String getAt(int i)
    
    Retrieve the i-th component in a version number
    Parameters:
    i - The i-th index of the component to retrieve. The first is 0.
    Returns:
    The i-th version number component string
  - java.lang.String getMajor()
    
    Returns:
    The major version number ie. the first component
  - java.lang.String getMinor()
    
    Returns:
    The minor version number ie. the second component
  - java.lang.String getPatch()
    
    Returns:
    The minor version number ie. the third component
  - @java.lang.Override int hashCode()
  - boolean matches(java.lang.String condition)
    
    Checks if the version number satisfies the specified condition. The condition can be specified by prefix the request version with traditional logical operators eg:
```
    assert new VersionNumber('1.2').check('< 1.4')
    assert new VersionNumber('2.3').check('>= 2.0')
 
```
    Or by post-fixing the request version by using a `+` sign, eg:
```
    assert new VersionNumber('1.2').check('1.1+')
    assert new VersionNumber('2.3').check('2.+')
 
```
    Parameters:
    condition
    Returns:
  - int size()
    
    Returns:
    The number of components in the version number eg new VersionNumber('2.3.12').size() == 3
  - java.lang.String toString()

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class VersionNumber

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

VersionNumber(java.lang.String str)

Method Detail

@java.lang.Override int compareTo(java.lang.Object obj)

@java.lang.Override boolean equals(java.lang.Object other)

java.lang.String getAt(int i)

java.lang.String getMajor()

java.lang.String getMinor()

java.lang.String getPatch()

@java.lang.Override int hashCode()

boolean matches(java.lang.String condition)

int size()

java.lang.String toString()