com.vdurmont.semver4j

Class Requirement

java.lang.Object

com.vdurmont.semver4j.Requirement

public class Requirement
extends Object

A requirement will provide an easy way to check if a version is satisfying. There are 2 types of requirements: - Strict: checks if a version is equivalent to another - NPM: follows the rules of NPM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Requirement.RequirementOperator The operators that can be used in a requirement.

Field Summary

Fields

Modifier and Type	Field and Description
protected Requirement.RequirementOperator	op
protected Range	range
protected Requirement	req1
protected Requirement	req2

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Requirement(Range range, Requirement req1, Requirement.RequirementOperator op, Requirement req2) Builds a requirement.

Method Summary

Modifier and Type	Method and Description
static Requirement	build(Semver requirement) Builds a requirement (will test that the version is equivalent to the requirement)
static Requirement	buildCocoapods(String requirement) Builds a requirement following the rules of Cocoapods.
static Requirement	buildIvy(String requirement) Builds a requirement following the rules of Ivy.
static Requirement	buildLoose(String requirement) Builds a loose requirement (will test that the version is equivalent to the requirement)
static Requirement	buildNPM(String requirement) Builds a requirement following the rules of NPM.
static Requirement	buildStrict(String requirement) Builds a strict requirement (will test that the version is equivalent to the requirement)
protected static Requirement	caretRequirement(String version, Semver.SemverType type) Allows changes that do not modify the left-most non-zero digit in the [major, minor, patch] tuple.
boolean	equals(Object o)
Semver.SemverType	getType()
int	hashCode()
protected static Requirement	hyphenRequirement(String lowerVersion, String upperVersion, Semver.SemverType type) Creates a requirement that satisfies "x1.y1.z1 - x2.y2.z2".
boolean	isSatisfiedBy(Semver version) Checks if the requirement is satisfied by a version.
boolean	isSatisfiedBy(String version)
protected static Requirement	tildeRequirement(String version, Semver.SemverType type) Allows patch-level changes if a minor version is specified on the comparator.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

range

protected final Range range

req1

protected final Requirement req1

op

protected final Requirement.RequirementOperator op

req2

protected final Requirement req2

Constructor Detail

Requirement

protected Requirement(Range range,
                      Requirement req1,
                      Requirement.RequirementOperator op,
                      Requirement req2)

Builds a requirement. (private use only) A requirement has to be a range or a combination of an operator and 2 other requirements.

Parameters:

range - the range that will be used for the requirement (optional if all other params are provided)

req1 - the requirement used as a left operand (requires the `op` and `req2` params to be provided)

op - the operator used between the requirements (requires the `req1` and `req2` params to be provided)

req2 - the requirement used as a right operand (requires the `req1` and `op` params to be provided)

Method Detail

build

public static Requirement build(Semver requirement)

Builds a requirement (will test that the version is equivalent to the requirement)

Parameters:

requirement - the version of the requirement

Returns:

the generated requirement

buildStrict

public static Requirement buildStrict(String requirement)

Builds a strict requirement (will test that the version is equivalent to the requirement)

Parameters:

requirement - the version of the requirement

Returns:

the generated requirement

buildLoose

public static Requirement buildLoose(String requirement)

Builds a loose requirement (will test that the version is equivalent to the requirement)

Parameters:

requirement - the version of the requirement

Returns:

the generated requirement

buildNPM

public static Requirement buildNPM(String requirement)

Builds a requirement following the rules of NPM.

Parameters:

requirement - the requirement as a string

Returns:

the generated requirement

buildCocoapods

public static Requirement buildCocoapods(String requirement)

Builds a requirement following the rules of Cocoapods.

Parameters:

requirement - the requirement as a string

Returns:

the generated requirement

buildIvy

public static Requirement buildIvy(String requirement)

Builds a requirement following the rules of Ivy.

Parameters:

requirement - the requirement as a string

Returns:

the generated requirement

tildeRequirement

protected static Requirement tildeRequirement(String version,
                                              Semver.SemverType type)

Allows patch-level changes if a minor version is specified on the comparator. Allows minor-level changes if not.

Parameters:

version - the version of the requirement

type - the version system used for this requirement

Returns:

the generated requirement

caretRequirement

protected static Requirement caretRequirement(String version,
                                              Semver.SemverType type)

Allows changes that do not modify the left-most non-zero digit in the [major, minor, patch] tuple.

Parameters:

version - the version of the requirement

type - the version system used for this requirement

Returns:

the generated requirement

hyphenRequirement

protected static Requirement hyphenRequirement(String lowerVersion,
                                               String upperVersion,
                                               Semver.SemverType type)

Creates a requirement that satisfies "x1.y1.z1 - x2.y2.z2".

Parameters:

lowerVersion - the version of the lower bound of the requirement

upperVersion - the version of the upper bound of the requirement

type - the version system used for this requirement

Returns:

the generated requirement

getType

public Semver.SemverType getType()

Returns:

Semver type

isSatisfiedBy

public boolean isSatisfiedBy(String version)

Parameters:

version - the version that will be checked

Returns:

true if the version satisfies the requirement

See Also:

isSatisfiedBy(Semver)

isSatisfiedBy

public boolean isSatisfiedBy(Semver version)

Checks if the requirement is satisfied by a version.

Parameters:

version - the version that will be checked

Returns:

true if the version satisfies the requirement

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object