Semver (semver4j 3.1.1 API)

java.lang.Object
- com.vdurmont.semver4j.Semver

All Implemented Interfaces:

Comparable<Semver>
```
public class Semver
extends Object
implements Comparable<Semver>
```
Semver is a tool that provides useful methods to manipulate versions that follow the "semantic versioning" specification (see http://semver.org)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Semver.SemverType` The different types of supported version systems.
`static class`	`Semver.VersionDiff` The types of diffs between two versions.

Constructor Summary

Constructors
Constructor and Description

Semver(String value)

Semver(String value, Semver.SemverType type)

Constructors
Constructor and Description
`Semver(String value)`
`Semver(String value, Semver.SemverType type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Semver version)`
`Semver.VersionDiff`	`diff(Semver version)` Returns the greatest difference between 2 versions.
`Semver.VersionDiff`	`diff(String version)`
`boolean`	`equals(Object o)`
`String`	`getBuild()` Returns the build of the version.
`Integer`	`getMajor()` Returns the major part of the version.
`Integer`	`getMinor()` Returns the minor part of the version.
`String`	`getOriginalValue()` Get the original value as a string
`Integer`	`getPatch()` Returns the patch part of the version.
`String[]`	`getSuffixTokens()` Returns the suffix of the version.
`Semver.SemverType`	`getType()`
`String`	`getValue()` Returns the version as a String
`int`	`hashCode()`
`boolean`	`isEqualTo(Semver version)` Checks if the version equals another version
`boolean`	`isEqualTo(String version)`
`boolean`	`isEquivalentTo(Semver version)` Checks if the version equals another version, without taking the build into account.
`boolean`	`isEquivalentTo(String version)`
`boolean`	`isGreaterThan(Semver version)` Checks if the version is greater than another version
`boolean`	`isGreaterThan(String version)`
`boolean`	`isGreaterThanOrEqualTo(Semver version)` Checks if the version is greater than or equal to another version
`boolean`	`isGreaterThanOrEqualTo(String version)`
`boolean`	`isLowerThan(Semver version)` Checks if the version is lower than another version
`boolean`	`isLowerThan(String version)`
`boolean`	`isLowerThanOrEqualTo(Semver version)` Checks if the version is lower than or equal to another version
`boolean`	`isLowerThanOrEqualTo(String version)`
`boolean`	`isPreRelease()` Checks whether the version is a pre-release
`boolean`	`isStable()` Determines if the current version is stable or not.
`Semver`	`nextMajor()`
`Semver`	`nextMinor()`
`Semver`	`nextPatch()`
`boolean`	`satisfies(Requirement requirement)` Check if the version satisfies a requirement
`boolean`	`satisfies(String requirement)` Check if the version satisfies a requirement
`Semver`	`toStrict()`
`String`	`toString()`
`Semver`	`withBuild(String build)`
`Semver`	`withClearedBuild()`
`Semver`	`withClearedSuffix()`
`Semver`	`withClearedSuffixAndBuild()`
`Semver`	`withIncMajor()`
`Semver`	`withIncMajor(int increment)`
`Semver`	`withIncMinor()`
`Semver`	`withIncMinor(int increment)`
`Semver`	`withIncPatch()`
`Semver`	`withIncPatch(int increment)`
`Semver`	`withIncSuffix(int index)`
`Semver`	`withIncSuffix(int index, int increment)`
`Semver`	`withSuffix(String suffix)`

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

- Constructor Detail
  - Semver
```
public Semver(String value)
```
  - Semver
```
public Semver(String value,
              Semver.SemverType type)
```
- Method Detail
  - satisfies
```
public boolean satisfies(Requirement requirement)
```
    Check if the version satisfies a requirement
    
    Parameters:
    
    requirement - the requirement
    
    Returns:
    
    true if the version satisfies the requirement
  - satisfies
```
public boolean satisfies(String requirement)
```
    Check if the version satisfies a requirement
    
    Parameters:
    
    requirement - the requirement
    
    Returns:
    
    true if the version satisfies the requirement
  - isPreRelease
```
public boolean isPreRelease()
```
    Checks whether the version is a pre-release
    
    Returns:
    
    true if the current version is a prerelease
  - isGreaterThan
```
public boolean isGreaterThan(String version)
```
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version is greater than the provided version
    
    See Also:
    
    isGreaterThan(Semver)
  - isGreaterThan
```
public boolean isGreaterThan(Semver version)
```
    Checks if the version is greater than another version
    
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version is greater than the provided version
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(String version)
```
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version is greater than or equal to the provided version
    
    See Also:
    
    isGreaterThanOrEqualTo(Semver)
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(Semver version)
```
    Checks if the version is greater than or equal to another version
    
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version is greater than or equal to the provided version
  - isLowerThan
```
public boolean isLowerThan(String version)
```
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version is lower than the provided version
    
    See Also:
    
    isLowerThan(Semver)
  - isLowerThan
```
public boolean isLowerThan(Semver version)
```
    Checks if the version is lower than another version
    
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version is lower than the provided version
  - isLowerThanOrEqualTo
```
public boolean isLowerThanOrEqualTo(String version)
```
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version is lower than or equal to the provided version
    
    See Also:
    
    isLowerThanOrEqualTo(Semver)
  - isLowerThanOrEqualTo
```
public boolean isLowerThanOrEqualTo(Semver version)
```
    Checks if the version is lower than or equal to another version
    
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version is lower than or equal to the provided version
  - isEquivalentTo
```
public boolean isEquivalentTo(String version)
```
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version equals the provided version (build excluded)
    
    See Also:
    
    isEquivalentTo(Semver)
  - isEquivalentTo
```
public boolean isEquivalentTo(Semver version)
```
    Checks if the version equals another version, without taking the build into account.
    
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version equals the provided version (build excluded)
  - isEqualTo
```
public boolean isEqualTo(String version)
```
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version equals the provided version
    
    See Also:
    
    isEqualTo(Semver)
  - isEqualTo
```
public boolean isEqualTo(Semver version)
```
    Checks if the version equals another version
    
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    true if the current version equals the provided version
  - isStable
```
public boolean isStable()
```
    Determines if the current version is stable or not. Stable version have a major version number strictly positive and no suffix tokens.
    
    Returns:
    
    true if the current version is stable
  - diff
```
public Semver.VersionDiff diff(String version)
```
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    the greatest difference
    
    See Also:
    
    diff(Semver)
  - diff
```
public Semver.VersionDiff diff(Semver version)
```
    Returns the greatest difference between 2 versions. For example, if the current version is "1.2.3" and compared version is "1.3.0", the biggest difference is the 'MINOR' number.
    
    Parameters:
    
    version - the version to compare
    
    Returns:
    
    the greatest difference
  - toStrict
```
public Semver toStrict()
```
  - withIncMajor
```
public Semver withIncMajor()
```
  - withIncMajor
```
public Semver withIncMajor(int increment)
```
  - withIncMinor
```
public Semver withIncMinor()
```
  - withIncMinor
```
public Semver withIncMinor(int increment)
```
  - withIncPatch
```
public Semver withIncPatch()
```
  - withIncPatch
```
public Semver withIncPatch(int increment)
```
  - withIncSuffix
```
public Semver withIncSuffix(int index)
```
  - withIncSuffix
```
public Semver withIncSuffix(int index,
                            int increment)
```
  - withClearedSuffix
```
public Semver withClearedSuffix()
```
  - withClearedBuild
```
public Semver withClearedBuild()
```
  - withClearedSuffixAndBuild
```
public Semver withClearedSuffixAndBuild()
```
  - withSuffix
```
public Semver withSuffix(String suffix)
```
  - withBuild
```
public Semver withBuild(String build)
```
  - nextMajor
```
public Semver nextMajor()
```
  - nextMinor
```
public Semver nextMinor()
```
  - nextPatch
```
public Semver nextPatch()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Semver version)
```
    Specified by:
    
    compareTo in interface Comparable<Semver>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getOriginalValue
```
public String getOriginalValue()
```
    Get the original value as a string
    
    Returns:
    
    the original string passed in the constructor
  - getValue
```
public String getValue()
```
    Returns the version as a String
    
    Returns:
    
    the version as a String
  - getMajor
```
public Integer getMajor()
```
    Returns the major part of the version. Example: for "1.2.3" = 1
    
    Returns:
    
    the major part of the version
  - getMinor
```
public Integer getMinor()
```
    Returns the minor part of the version. Example: for "1.2.3" = 2
    
    Returns:
    
    the minor part of the version
  - getPatch
```
public Integer getPatch()
```
    Returns the patch part of the version. Example: for "1.2.3" = 3
    
    Returns:
    
    the patch part of the version
  - getSuffixTokens
```
public String[] getSuffixTokens()
```
    Returns the suffix of the version. Example: for "1.2.3-beta.4+sha98450956" = {"beta", "4"}
    
    Returns:
    
    the suffix of the version
  - getBuild
```
public String getBuild()
```
    Returns the build of the version. Example: for "1.2.3-beta.4+sha98450956" = "sha98450956"
    
    Returns:
    
    the build of the version
  - getType
```
public Semver.SemverType getType()
```

Class Semver

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Semver

Semver

Method Detail

satisfies

satisfies

isPreRelease

isGreaterThan

isGreaterThan

isGreaterThanOrEqualTo

isGreaterThanOrEqualTo

isLowerThan

isLowerThan

isLowerThanOrEqualTo

isLowerThanOrEqualTo

isEquivalentTo

isEquivalentTo

isEqualTo

isEqualTo

isStable

diff

diff

toStrict

withIncMajor

withIncMajor

withIncMinor

withIncMinor

withIncPatch

withIncPatch

withIncSuffix

withIncSuffix

withClearedSuffix

withClearedBuild

withClearedSuffixAndBuild

withSuffix

withBuild

nextMajor

nextMinor

nextPatch

equals

hashCode

compareTo

toString

getOriginalValue

getValue

getMajor

getMinor

getPatch

getSuffixTokens

getBuild

getType