RaptorVersion (BuildSupportPlugin 0.7.2 API)

gov.raptor.gradle.plugins.buildsupport.RaptorVersion

Simple class to handler tri-part version numbers including a stage tag, like 2.6.1-RC1. All parts are expected to be numeric, except the stage, which can be an arbitrary string.
Authors:
Proprietary information subject to the terms of a Non-Disclosure Agreement

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`SNAPSHOT`

Properties Summary

Properties
Type	Name and description
`int`	`patch`
`java.lang.String`	`stage`

Constructor Summary

Constructors
Constructor and description
`RaptorVersion (java.lang.String versionString)` Construct from the given version string.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`asSnapshot()` Return the version with any existing stage replaced with 'SNAPSHOT'.
	`void`	`bumpMinor()` Increment the minor component number.
	`void`	`bumpPatch()` Increment the patch component number.
	`boolean`	`equals(java.lang.Object o)`
	`int`	`getMajor()` @return The major component as an integer
	`java.lang.String`	`getMajorMinor()` Get the major and minor components of the version.
	`int`	`getMinor()` @return The minor component as an integer
	`int`	`getPatch()` @return The patch component as an integer
	`java.lang.String`	`getRootVersion()` @return the 'root' version (without the stage), e.g., for '2.6.1-SNAPSHOT' this returns '2.6.1'
	`java.lang.String`	`getStage()` Returns: The stage, if any.
	`int`	`hashCode()`
	`boolean`	`isFinal()` @return `true` if the stage of this version is empty (final)
	`boolean`	`isSnapshot()` @return `true` if the stage of this version is SNAPSHOT
	`void`	`setPatch(int patch)` Set the patch component to the give value.
	`void`	`setStage(java.lang.String stage)` Set the stage to the given value.
	`java.lang.String`	`toString()` @return The full version including the stage, e.g., '2.6.1-RC1'

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()`

- Field Detail
  - public static final java.lang.String SNAPSHOT
- Property Detail
  - int patch
  - java.lang.String stage
- Constructor Detail
  - RaptorVersion(java.lang.String versionString)
    
    Construct from the given version string. The string must be of the form 'X.Y.Z' or 'X.Y.Z-STAGE'. If X, Y, and Z are not each convertible to an integer, then an exception will be thrown.
    Parameters:
    versionString - The string to parse, e.g., '2.6.1-RC1'
- Method Detail
  - java.lang.String asSnapshot()
    
    Return the version with any existing stage replaced with 'SNAPSHOT'. For example, if this version is 2.6.1-RC1, then this method would return '2.6.1-SNAPSHOT'.
    Returns:
    This version with a stage of SNAPSHOT
  - void bumpMinor()
    
    Increment the minor component number.
  - void bumpPatch()
    
    Increment the patch component number.
  - boolean equals(java.lang.Object o)
  - int getMajor()
    
    Returns:
    The major component as an integer
  - java.lang.String getMajorMinor()
    
    Get the major and minor components of the version. For example, if the full version is 2.6.1-RC1, then this method returns '2.6'.
    Returns:
    The major/minor components of the version
  - int getMinor()
    
    Returns:
    The minor component as an integer
  - int getPatch()
    
    Returns:
    The patch component as an integer
  - java.lang.String getRootVersion()
    
    Returns:
    the 'root' version (without the stage), e.g., for '2.6.1-SNAPSHOT' this returns '2.6.1'
  - java.lang.String getStage()
    
    Returns:
    The stage, if any. E.g., on a version of '2.6.1-RC1' this returns 'RC1'
  - int hashCode()
  - boolean isFinal()
    
    Returns:
    true if the stage of this version is empty (final)
  - boolean isSnapshot()
    
    Returns:
    true if the stage of this version is SNAPSHOT
  - void setPatch(int patch)
    
    Set the patch component to the give value.
    Parameters:
    patch - New patch value
  - void setStage(java.lang.String stage)
    
    Set the stage to the given value.
    Parameters:
    stage - New stage value
  - java.lang.String toString()
    
    Returns:
    The full version including the stage, e.g., '2.6.1-RC1'

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class RaptorVersion

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String SNAPSHOT

Property Detail

int patch

java.lang.String stage

Constructor Detail

RaptorVersion(java.lang.String versionString)

Method Detail

java.lang.String asSnapshot()

void bumpMinor()

void bumpPatch()

boolean equals(java.lang.Object o)

int getMajor()

java.lang.String getMajorMinor()

int getMinor()

int getPatch()

java.lang.String getRootVersion()

java.lang.String getStage()

int hashCode()

boolean isFinal()

boolean isSnapshot()

void setPatch(int patch)

void setStage(java.lang.String stage)

java.lang.String toString()