Version (grolifant-core 2.0.0-alpha.6 API)

org.ysb33r.grolifant.api.core.Version

All Implemented Interfaces and Traits:

Comparable
```
@groovy.transform.CompileStatic
@groovy.transform.EqualsAndHashCode
class Version
extends Object
```
A class for comparing versions. A major parts of the logic in this class is based upon org.gradle.util.GradleVersion.
Since:
0.9

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Version.ParseException`
`static class`	`Version.Parts`

Properties Summary

Properties
Type	Name and description
`static java.util.regex.Pattern`	`EXTRAS_PARSER` Extract bits out of the extra section.
`static java.util.regex.Pattern`	`EXTRAS_WITH_SNAPSHOT_PARSER` Patterns for identifying extras which also contains a SNAPSHOT.
`static java.util.regex.Pattern`	`INITIAL_PARSER` The initial parse is used to extract major, minor, patch and any extras.
`static java.util.regex.Pattern`	`SNAPSHOT_PARSER` Regex to identify extras as SNAPSHOT.
`boolean`	`alpha` Whether the version is an alpha.
`Integer`	`alphaSequence`
`boolean`	`beta` Whether the version is a beta.
`Integer`	`betaSequence`
`int`	`major` The major version of the version.
`boolean`	`milestone` Whether the version is a milestone.
`Integer`	`milestoneSequence`
`int`	`minor` The minor part of the version.
`Integer`	`patch` The patch part of the version.
`boolean`	`rc` Whether the version is an RC.
`Integer`	`rcSequence`
`String`	`snapShotSequence`
`boolean`	`snapshot` Whether the version is a snapshot.
`String`	`version` The version the class was created with

Constructor Summary

Constructors
Constructor and description
`protected Version (String ver, Version.Parts parts)` Creates an instance of a Version object.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`compareTo(Version rhs)` Compares this object with the specified object for order.
	`static Version.Parts`	`defaultParser(String ver)` The default parser will look for something that roughly matches the following regex: {@code \d+\.
	`static Version`	`of(String ver)` Creates a new version instance from a parse-able string.
	`static Version`	`of(String ver, java.util.function.Function<String, Parts> parser)` Creates a new version instance from a parse-able string using a custom parser

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - static final java.util.regex.Pattern EXTRAS_PARSER
    
    Extract bits out of the extra section.
  - static final java.util.regex.Pattern EXTRAS_WITH_SNAPSHOT_PARSER
    
    Patterns for identifying extras which also contains a SNAPSHOT.
  - static final java.util.regex.Pattern INITIAL_PARSER
    
    The initial parse is used to extract major, minor, patch and any extras.
  - static final java.util.regex.Pattern SNAPSHOT_PARSER
    
    Regex to identify extras as SNAPSHOT.
  - final boolean alpha
    
    Whether the version is an alpha.
  - final Integer alphaSequence
  - final boolean beta
    
    Whether the version is a beta.
  - final Integer betaSequence
  - final int major
    
    The major version of the version. Never null.
  - final boolean milestone
    
    Whether the version is a milestone.
  - final Integer milestoneSequence
  - final int minor
    
    The minor part of the version. Never null.
  - final Integer patch
    
    The patch part of the version. Can be null.
  - final boolean rc
    
    Whether the version is an RC.
  - final Integer rcSequence
  - final String snapShotSequence
  - final boolean snapshot
    
    Whether the version is a snapshot.
  - final String version
    
    The version the class was created with
- Constructor Detail
  - protected Version(String ver, Version.Parts parts)
    
    Creates an instance of a Version object.
    Parameters:
    ver - Version string that was used
    parts - Decomposed parts
- Method Detail
  - @Override int compareTo(Version rhs)
    
    Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)
    The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.
    Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.
    It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."
    In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.
    throws:
    NullPointerException if the specified object is null
    throws:
    ClassCastException if the specified object's type prevents it from being compared to this object.
    
    Parameters:
    rhs - 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.
  - static Version.Parts defaultParser(String ver)
    
    The default parser will look for something that roughly matches the following regex: \d+\.\d+(\.\d+)?(-(alpha|beta|rc)\.\d+)?(-(SNAPSHOT|\d{14))?}.
    throws:
    Version.ParseException if the version could nto be parsed.
    
    Parameters:
    ver - Version to parse
    Returns:
    Parsed components
  - static Version of(String ver)
    
    Creates a new version instance from a parse-able string.
    Parameters:
    ver - Version string to parse.
    Returns:
    Version instance.
    Throws:
    Version.ParseException is parsing failed
  - static Version of(String ver, java.util.function.Function<String, Parts> parser)
    
    Creates a new version instance from a parse-able string using a custom parser
    Parameters:
    ver - Version string to parse.
    parser - Custom parser to use
    Returns:
    Version instance.
    Throws:
    Version.ParseException is parsing failed

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Version

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.util.regex.Pattern EXTRAS_PARSER

static final java.util.regex.Pattern EXTRAS_WITH_SNAPSHOT_PARSER

static final java.util.regex.Pattern INITIAL_PARSER

static final java.util.regex.Pattern SNAPSHOT_PARSER

final boolean alpha

final Integer alphaSequence

final boolean beta

final Integer betaSequence

final int major

final boolean milestone

final Integer milestoneSequence

final int minor

final Integer patch

final boolean rc

final Integer rcSequence

final String snapShotSequence

final boolean snapshot

final String version

Constructor Detail

protected Version(String ver, Version.Parts parts)

Method Detail

@Override int compareTo(Version rhs)

static Version.Parts defaultParser(String ver)

static Version of(String ver)

static Version of(String ver, java.util.function.Function<String, Parts> parser)