SemanticVersion (auderis-gradle-tools 1.0.1 API)

java.lang.Object
- cz.auderis.tools.gradle.SemanticVersion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SemanticVersion>
```
public class SemanticVersion
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<SemanticVersion>
```
As specified in Gradle documentation, project/module version may be an object of any type. Gradle uses its toString() to obtain the version string. However often there is a need for other, more detailed inspection of version number structure.
When adopting Semantic Versioning approach, a convenient class is made available by this library for Gradle scripts. The version may be defined either directly in the script or loaded from an external resource, such as a file or even URL.
```
 import cz.auderis.tools.gradle.SemanticVersion

 // build.gradle
 buildscript {
 // Define where to find the plugin module, e.g. mavenCentral()
 }

 // Use direct specification
 project.version = SemanticVersion.is("1.0.0-SNAPSHOT")

 // Load version specification from a file
 project version = SemanticVersion.from("version.txt")
 
```
An instance of SemanticVersion class has, among others, the following properties:
- majorVersion (with convenient alias major) returns first numeric part X from version X.Y.Z
- minorVersion (with convenient alias minor) returns numeric part Y from version X.Y.Z
- patchRevision (with convenient aliases patch and patchLevel) returns numeric part Z from version X.Y.Z
- prerelease is a boolean flag that indicates that either major version is 0 or there are pre-release identifiers present (part P in version string X.Y.Z-P). There is an alias preRelease available as well.
- stable is a boolean flag that is effectively a negation of prerelease property
- snapshot is a boolean flag that indicates whether a special pre-release ID SNAPSHOT is present in the version string (i.e. "1.4.2-SNAPSHOT")
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SemanticVersion.OrderBy

Nested Classes
Modifier and Type	Class and Description
`static class`	`SemanticVersion.OrderBy`

Field Summary

Fields
Modifier and Type Field and Description

static java.util.regex.Pattern IDENTIFIER_PATTERN

static java.util.regex.Pattern PATTERN

static java.lang.String SNAPSHOT_ID

Fields
Modifier and Type	Field and Description
`static java.util.regex.Pattern`	`IDENTIFIER_PATTERN`
`static java.util.regex.Pattern`	`PATTERN`
`static java.lang.String`	`SNAPSHOT_ID`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(SemanticVersion other)`
`boolean`	`equals(java.lang.Object obj)`
`static SemanticVersion`	`from(java.io.File versionHolder)` Loads a version string from a file and parses it into an instance of semantic version.
`static SemanticVersion`	`from(java.io.InputStream stream)` Loads a version string from the provided stream and parses it into an instance of semantic version.
`static SemanticVersion`	`from(java.lang.String source)` Tries to interpret the `source` argument as URL and uses it to parse a version string from its contents; if the argument is not a valid URL, it is considered to be a local file path.
`static SemanticVersion`	`from(java.net.URL url)` Loads a version string from the provided URL and parses it into an instance of semantic version.
`java.util.List<java.lang.String>`	`getBuildMetadataIdentifiers()`
`protected java.util.List<java.lang.String>`	`getBuildMetadataIds()`
`int`	`getMajor()` Deprecated.
`int`	`getMajorVersion()`
`int`	`getMinor()` Deprecated.
`int`	`getMinorVersion()`
`int`	`getPatch()` Deprecated.
`int`	`getPatchLevel()` Deprecated.
`int`	`getPatchRevision()`
`java.util.List<java.lang.String>`	`getPreReleaseIdentifiers()`
`protected java.util.List<java.lang.String>`	`getPreReleaseIds()`
`boolean`	`hasBuildMetadataIdentifier(java.lang.String id)`
`int`	`hashCode()`
`boolean`	`hasPreReleaseIdentifier(java.lang.String id)`
`static SemanticVersion`	`is(java.lang.String specification)` Creates an instance of semantic version directly from the provided version string
`boolean`	`isPrerelease()`
`boolean`	`isPreRelease()`
`boolean`	`isSnapshot()`
`boolean`	`isStable()`
`SemanticVersion`	`stripAllIdentifiers()`
`SemanticVersion`	`stripBuildMetadataIdentifiers()`
`SemanticVersion`	`stripPreReleaseIdentifiers()`
`java.lang.String`	`toString()`
`SemanticVersion`	`withBuildMetadataIdentifier(java.lang.String id)`
`SemanticVersion`	`withBuildMetadataIdentifiers(java.lang.String... ids)`
`SemanticVersion`	`withOptionalBuildMetadataIdentifier(java.lang.String id)`
`SemanticVersion`	`withOptionalPreReleaseIdentifier(java.lang.String id)`
`SemanticVersion`	`withPreReleaseIdentifier(java.lang.String id)`
`SemanticVersion`	`withPreReleaseIdentifiers(java.lang.String... ids)`

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

- Field Detail
  - PATTERN
```
public static final java.util.regex.Pattern PATTERN
```
  - IDENTIFIER_PATTERN
```
public static final java.util.regex.Pattern IDENTIFIER_PATTERN
```
  - SNAPSHOT_ID
```
public static final java.lang.String SNAPSHOT_ID
```
    See Also:
    Constant Field Values
- Method Detail
  - is
```
public static SemanticVersion is(java.lang.String specification)
```
    Creates an instance of semantic version directly from the provided version string
    
    Parameters:
    specification - text representation of semantic version
    
    Returns:
    instance of semantic version object
    
    Throws:
    
    java.lang.NullPointerException - when specification is null
    
    org.gradle.api.InvalidUserDataException - when specification does not conform to semantic version rules
  - from
```
public static SemanticVersion from(java.io.InputStream stream)
```
    Loads a version string from the provided stream and parses it into an instance of semantic version.
    The provided stream is expected to adhere to certain rules:
    1. It must be a text file (as understood by BufferedReader.readLine()
    2. At the beginning of the file (i.e. until a semantic version string is encountered), all blank lines and comment lines (lines where first non-whitespace characters are either # or //) are skipped.
    3. The first line that is neither blank nor comment must specify a valid semantic version.
    4. After the semantic version line is found, the parser terminates and the rest of the stream is ignored
    If these rules are not satisfied, the parser throws a InvalidUserDataException exception.
    Parameters:
    stream - source to be parsed
    
    Returns:
    instance of semantic version object
    
    Throws:
    
    java.lang.NullPointerException - when stream is null
    
    org.gradle.api.InvalidUserDataException - when contents of stream does not adhere to the rules or when the parsed version specification does not conform to semantic version rules
  - from
```
public static SemanticVersion from(java.io.File versionHolder)
```
    Loads a version string from a file and parses it into an instance of semantic version.
    The provided stream is expected to adhere to rules defined in from(InputStream).
    
    Parameters:
    versionHolder - source to be parsed
    
    Returns:
    instance of semantic version object
    
    Throws:
    
    java.lang.NullPointerException - when versionHolder is null
    
    org.gradle.api.InvalidUserDataException - when contents of versionHolder file does not adhere to the rules or when the parsed version specification does not conform to semantic version rules
  - from
```
public static SemanticVersion from(java.net.URL url)
```
    Loads a version string from the provided URL and parses it into an instance of semantic version.
    The provided stream is expected to adhere to rules defined in from(InputStream).
    
    Parameters:
    url - source object to be parsed
    
    Returns:
    instance of semantic version object
    
    Throws:
    
    java.lang.NullPointerException - when url is null
    
    org.gradle.api.InvalidUserDataException - when url is not accessible, contents of url does not adhere to the rules or when the parsed version specification does not conform to semantic version rules
  - from
```
public static SemanticVersion from(java.lang.String source)
```
    Tries to interpret the source argument as URL and uses it to parse a version string from its contents; if the argument is not a valid URL, it is considered to be a local file path.
    
    Parameters:
    source - text specification that must be either a valid URL or file path
    
    Returns:
    instance of semantic version object
    
    Throws:
    
    java.lang.NullPointerException - when source is null
    
    org.gradle.api.InvalidUserDataException - when source is not accessible, its contents does not adhere to the rules or when the parsed version specification does not conform to semantic version rules
  - getMajor
```
@Deprecated
public int getMajor()
```
    Deprecated.
  - getMajorVersion
```
public int getMajorVersion()
```
  - getMinor
```
@Deprecated
public int getMinor()
```
    Deprecated.
  - getMinorVersion
```
public int getMinorVersion()
```
  - getPatch
```
@Deprecated
public int getPatch()
```
    Deprecated.
  - getPatchLevel
```
@Deprecated
public int getPatchLevel()
```
    Deprecated.
  - getPatchRevision
```
public int getPatchRevision()
```
  - isPrerelease
```
public boolean isPrerelease()
```
  - isPreRelease
```
public boolean isPreRelease()
```
  - isStable
```
public boolean isStable()
```
  - isSnapshot
```
public boolean isSnapshot()
```
  - getPreReleaseIdentifiers
```
public java.util.List<java.lang.String> getPreReleaseIdentifiers()
```
  - hasPreReleaseIdentifier
```
public boolean hasPreReleaseIdentifier(java.lang.String id)
```
  - withPreReleaseIdentifier
```
public SemanticVersion withPreReleaseIdentifier(java.lang.String id)
```
  - withOptionalPreReleaseIdentifier
```
public SemanticVersion withOptionalPreReleaseIdentifier(java.lang.String id)
```
  - withPreReleaseIdentifiers
```
public SemanticVersion withPreReleaseIdentifiers(java.lang.String... ids)
```
  - stripPreReleaseIdentifiers
```
public SemanticVersion stripPreReleaseIdentifiers()
```
  - getPreReleaseIds
```
protected java.util.List<java.lang.String> getPreReleaseIds()
```
  - getBuildMetadataIdentifiers
```
public java.util.List<java.lang.String> getBuildMetadataIdentifiers()
```
  - hasBuildMetadataIdentifier
```
public boolean hasBuildMetadataIdentifier(java.lang.String id)
```
  - withBuildMetadataIdentifier
```
public SemanticVersion withBuildMetadataIdentifier(java.lang.String id)
```
  - withOptionalBuildMetadataIdentifier
```
public SemanticVersion withOptionalBuildMetadataIdentifier(java.lang.String id)
```
  - withBuildMetadataIdentifiers
```
public SemanticVersion withBuildMetadataIdentifiers(java.lang.String... ids)
```
  - stripBuildMetadataIdentifiers
```
public SemanticVersion stripBuildMetadataIdentifiers()
```
  - getBuildMetadataIds
```
protected java.util.List<java.lang.String> getBuildMetadataIds()
```
  - stripAllIdentifiers
```
public SemanticVersion stripAllIdentifiers()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(SemanticVersion other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<SemanticVersion>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SemanticVersion

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATTERN

IDENTIFIER_PATTERN

SNAPSHOT_ID

Method Detail

is

from

from

from

from

getMajor

getMajorVersion

getMinor

getMinorVersion

getPatch

getPatchLevel

getPatchRevision

isPrerelease

isPreRelease

isStable

isSnapshot

getPreReleaseIdentifiers

hasPreReleaseIdentifier

withPreReleaseIdentifier

withOptionalPreReleaseIdentifier

withPreReleaseIdentifiers

stripPreReleaseIdentifiers

getPreReleaseIds

getBuildMetadataIdentifiers

hasBuildMetadataIdentifier

withBuildMetadataIdentifier

withOptionalBuildMetadataIdentifier

withBuildMetadataIdentifiers

stripBuildMetadataIdentifiers

getBuildMetadataIds

stripAllIdentifiers

equals

hashCode

compareTo

toString