Index

A

addBuildIdentifiers(String...) - Method in class com.github.zafarkhaja.semver.Version.Builder

Appends (additional) build identifier(s).

addPreReleaseIdentifiers(String...) - Method in class com.github.zafarkhaja.semver.Version.Builder

Appends (additional) pre-release identifier(s).

and(Expression) - Method in class com.github.zafarkhaja.semver.expr.CompositeExpression

Adds another Expression to CompositeExpression using And logical expression.

B

build() - Method in class com.github.zafarkhaja.semver.Version.Builder

Obtains a Version instance with previously set values.

BUILD_AWARE_ORDER - Static variable in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.compareTo(Version)

Builder() - Constructor for class com.github.zafarkhaja.semver.Version.Builder

Default constructor, initializes fields with default values (0.0.0)

Builder(String) - Constructor for class com.github.zafarkhaja.semver.Version.Builder

Deprecated.

forRemoval since 0.10.0

buildMetadata() - Method in class com.github.zafarkhaja.semver.Version

Returns this Version's build metadata in the form of dot-separated identifiers.

C

com.github.zafarkhaja.semver - module com.github.zafarkhaja.semver

 

com.github.zafarkhaja.semver - package com.github.zafarkhaja.semver

This is the root package of the Java SemVer library.

com.github.zafarkhaja.semver.expr - package com.github.zafarkhaja.semver.expr

This package contains classes that implement the SemVer Expressions.

com.github.zafarkhaja.semver.util - package com.github.zafarkhaja.semver.util

This package provides some useful utility classes.

compareTo(Version) - Method in class com.github.zafarkhaja.semver.Version

Compares versions, along with their build metadata.

compareToIgnoreBuildMetadata(Version) - Method in class com.github.zafarkhaja.semver.Version

Compares versions, ignoring their build metadata.

compareWithBuildsTo(Version) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.compareTo(Version)

CompositeExpression - Class in com.github.zafarkhaja.semver.expr

This class implements internal DSL for the SemVer Expressions using fluent interface.

CompositeExpression(Expression) - Constructor for class com.github.zafarkhaja.semver.expr.CompositeExpression

Constructs a CompositeExpression with an underlying Expression.

CompositeExpression.Helper - Class in com.github.zafarkhaja.semver.expr

A class with static helper methods.

consume() - Method in class com.github.zafarkhaja.semver.util.Stream

Consumes the next element in this stream.

consume(T...) - Method in class com.github.zafarkhaja.semver.util.Stream

Consumes the next element in this stream only if it is of the expected types.

currentOffset() - Method in class com.github.zafarkhaja.semver.util.Stream

Returns the current offset of this stream.

E

eq(Version) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying Equal expression.

eq(String) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying Equal expression.

equals(Object) - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version exactly equals the specified Version.

Expression - Interface in com.github.zafarkhaja.semver.expr

The Expression interface is to be implemented by the nodes of the Abstract Syntax Tree produced by the ExpressionParser class.

ExpressionParser - Class in com.github.zafarkhaja.semver.expr

A parser for the SemVer Expressions.

F

forIntegers(int) - Static method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.of(long)

forIntegers(int, int) - Static method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.of(long, long)

forIntegers(int, int, int) - Static method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.of(long, long, long)

G

getBuildMetadata() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.buildMetadata()

getExpectedElementTypes() - Method in exception class com.github.zafarkhaja.semver.util.UnexpectedElementException

Gets the expected element types.

getMajorVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.majorVersion()

getMinorVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.minorVersion()

getNormalVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0

getPatchVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.patchVersion()

getPosition() - Method in exception class com.github.zafarkhaja.semver.util.UnexpectedElementException

Gets the position of the unexpected element.

getPreReleaseVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.preReleaseVersion()

getUnexpectedElement() - Method in exception class com.github.zafarkhaja.semver.util.UnexpectedElementException

Gets the unexpected element.

greaterThan(Version) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.isHigherThan(Version)

greaterThanOrEqualTo(Version) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.isHigherThanOrEquivalentTo(Version)

gt(Version) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying Greater expression.

gt(String) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying Greater expression.

gte(Version) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying GreaterOrEqual expression.

gte(String) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying GreaterOrEqual expression.

H

hashCode() - Method in class com.github.zafarkhaja.semver.Version

Helper() - Constructor for class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

 

I

INCREMENT_ORDER - Static variable in class com.github.zafarkhaja.semver.Version

A comparator that sorts versions in increment order, from lowest to highest.

incrementBuildMetadata() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0

incrementMajorVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.nextMajorVersion(String...)

incrementMajorVersion(String) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.nextMajorVersion(String...)

incrementMinorVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.nextMinorVersion(String...)

incrementMinorVersion(String) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.nextMinorVersion(String...)

incrementPatchVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.nextPatchVersion(String...)

incrementPatchVersion(String) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.nextPatchVersion(String...)

incrementPreReleaseVersion() - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.nextPreReleaseVersion(String...)

interpret(Version) - Method in class com.github.zafarkhaja.semver.expr.CompositeExpression

Interprets the expression.

interpret(Version) - Method in interface com.github.zafarkhaja.semver.expr.Expression

Interprets the expression.

interpret(String) - Method in class com.github.zafarkhaja.semver.expr.CompositeExpression

Interprets the expression.

isEquivalentTo(Version) - Method in class com.github.zafarkhaja.semver.Version

Determines if this Version has the same precedence as the specified Version.

isHigherThan(Version) - Method in class com.github.zafarkhaja.semver.Version

Determines if this Version has a higher precedence compared with the specified Version.

isHigherThanOrEquivalentTo(Version) - Method in class com.github.zafarkhaja.semver.Version

Determines if this Version has a higher or equal precedence compared with the specified Version.

isLowerThan(Version) - Method in class com.github.zafarkhaja.semver.Version

Determines if this Version has a lower precedence compared with the specified Version.

isLowerThanOrEquivalentTo(Version) - Method in class com.github.zafarkhaja.semver.Version

Determines if this Version has a lower or equal precedence compared with the specified Version.

isMatchedBy(E) - Method in interface com.github.zafarkhaja.semver.util.Stream.ElementType

Checks if the specified element matches this type.

isPreRelease() - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version represents a pre-release version.

isPublicApiCompatibleWith(Version) - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version is compatible with the specified Version in terms of their public API.

isPublicApiStable() - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version represents a stable public API.

isSameMajorVersionAs(Version) - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version is compatible with the specified Version in terms of their major versions.

isSameMinorVersionAs(Version) - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version is compatible with the specified Version in terms of their major and minor versions.

isSamePatchVersionAs(Version) - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version is compatible with the specified Version in terms of their major, minor and patch versions.

isStable() - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version represents a stable version.

isValid(String) - Static method in class com.github.zafarkhaja.semver.Version

Checks validity of the specified SemVer version string in strict mode, which ensures full compliance with the specification.

isValid(String, boolean) - Static method in class com.github.zafarkhaja.semver.Version

Checks validity of the specified SemVer version string.

iterator() - Method in class com.github.zafarkhaja.semver.util.Stream

Returns an iterator over elements that are left in this stream.

L

lessThan(Version) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.isLowerThan(Version)

lessThanOrEqualTo(Version) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.isLowerThanOrEquivalentTo(Version)

LexerException - Exception Class in com.github.zafarkhaja.semver.expr

Thrown during the lexical analysis when an illegal character is encountered.

lookahead() - Method in class com.github.zafarkhaja.semver.util.Stream

Returns the next element in this stream without consuming it.

lookahead(int) - Method in class com.github.zafarkhaja.semver.util.Stream

Returns the element at the specified position in this stream without consuming it.

lt(Version) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying Less expression.

lt(String) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying Less expression.

lte(Version) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying LessOrEqual expression.

lte(String) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying LessOrEqual expression.

M

majorVersion() - Method in class com.github.zafarkhaja.semver.Version

Returns this Version's major version.

minorVersion() - Method in class com.github.zafarkhaja.semver.Version

Returns this Version's minor version.

N

neq(Version) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying NotEqual expression.

neq(String) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying NotEqual expression.

newInstance() - Static method in class com.github.zafarkhaja.semver.expr.ExpressionParser

Creates and returns new instance of the ExpressionParser class.

nextMajorVersion(long, String...) - Method in class com.github.zafarkhaja.semver.Version

Obtains the next Version of the specified major version number, with an optional pre-release version label.

nextMajorVersion(String...) - Method in class com.github.zafarkhaja.semver.Version

Obtains the next Version by incrementing the major version number by one, with an optional pre-release version label.

nextMinorVersion(long, String...) - Method in class com.github.zafarkhaja.semver.Version

Obtains the next Version of the specified minor version number, with an optional pre-release version label.

nextMinorVersion(String...) - Method in class com.github.zafarkhaja.semver.Version

Obtains the next Version by incrementing the minor version number by one, with an optional pre-release version label.

nextPatchVersion(long, String...) - Method in class com.github.zafarkhaja.semver.Version

Obtains the next Version of the specified patch version number, with an optional pre-release version label.

nextPatchVersion(String...) - Method in class com.github.zafarkhaja.semver.Version

Obtains the next Version by incrementing the patch version number by one, with an optional pre-release version label.

nextPreReleaseVersion(String...) - Method in class com.github.zafarkhaja.semver.Version

Obtains the next Version by incrementing or replacing the pre-release version.

not(Expression) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper

Creates a CompositeExpression with an underlying Not expression.

O

of(long) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major version.

of(long, long) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major and minor versions.

of(long, long, long) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major, minor and patch versions.

of(long, long, long, String) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major, minor, patch and pre-release versions.

of(long, long, long, String, String) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major, minor, patch and pre-release versions, as well as build metadata.

of(long, long, String) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major, minor and pre-release versions.

of(long, long, String, String) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major, minor and pre-release versions, as well as build metadata.

of(long, String) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major and pre-release versions.

of(long, String, String) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance of the specified major and pre-release versions, as well as build metadata.

or(Expression) - Method in class com.github.zafarkhaja.semver.expr.CompositeExpression

Adds another Expression to CompositeExpression using Or logical expression.

P

parse(String) - Method in class com.github.zafarkhaja.semver.expr.ExpressionParser

Parses the SemVer Expressions.

parse(String) - Method in interface com.github.zafarkhaja.semver.Parser

Parses the input string.

parse(String) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance by parsing the specified string in strict mode, which ensures full compliance with the specification.

parse(String, boolean) - Static method in class com.github.zafarkhaja.semver.Version

Obtains a Version instance by parsing the specified string.

ParseException - Exception Class in com.github.zafarkhaja.semver

Thrown to indicate an error during the parsing.

ParseException() - Constructor for exception class com.github.zafarkhaja.semver.ParseException

Constructs a ParseException instance with no error message.

ParseException(String) - Constructor for exception class com.github.zafarkhaja.semver.ParseException

Constructs a ParseException instance with an error message.

ParseException(String, UnexpectedCharacterException) - Constructor for exception class com.github.zafarkhaja.semver.ParseException

Constructs a ParseException instance with an error message and the cause exception.

Parser<T> - Interface in com.github.zafarkhaja.semver

A parser interface.

patchVersion() - Method in class com.github.zafarkhaja.semver.Version

Returns this Version's patch version.

positiveLookahead(T...) - Method in class com.github.zafarkhaja.semver.util.Stream

Checks if the next element in this stream is of the expected types.

positiveLookaheadBefore(Stream.ElementType<E>, T...) - Method in class com.github.zafarkhaja.semver.util.Stream

Checks if there exists an element in this stream of the expected types before the specified type.

positiveLookaheadUntil(int, T...) - Method in class com.github.zafarkhaja.semver.util.Stream

Checks if there is an element in this stream of the expected types until the specified position.

PRECEDENCE_ORDER - Static variable in class com.github.zafarkhaja.semver.Version

A comparator that sorts versions in (highest) precedence order.

preReleaseVersion() - Method in class com.github.zafarkhaja.semver.Version

Returns this Version's pre-release version in the form of dot-separated identifiers.

pushBack() - Method in class com.github.zafarkhaja.semver.util.Stream

Pushes back one element at a time.

S

satisfies(String) - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version satisfies the specified range expression.

satisfies(Predicate<Version>) - Method in class com.github.zafarkhaja.semver.Version

Checks if this Version satisfies the specified predicate.

setBuildMetadata(String) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.withBuildMetadata(String...)

setBuildMetadata(String...) - Method in class com.github.zafarkhaja.semver.Version.Builder

Sets the build metadata.

setMajorVersion(long) - Method in class com.github.zafarkhaja.semver.Version.Builder

Sets the major version.

setMinorVersion(long) - Method in class com.github.zafarkhaja.semver.Version.Builder

Sets the minor version.

setNormalVersion(String) - Method in class com.github.zafarkhaja.semver.Version.Builder

Deprecated.

forRemoval since 0.10.0

setPatchVersion(long) - Method in class com.github.zafarkhaja.semver.Version.Builder

Sets the patch version.

setPreReleaseVersion(String) - Method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, consider using Version.nextPreReleaseVersion(String...)

setPreReleaseVersion(String...) - Method in class com.github.zafarkhaja.semver.Version.Builder

Sets the pre-release version.

setVersionCore(long) - Method in class com.github.zafarkhaja.semver.Version.Builder

Sets the major version; the minor and patch versions are assigned 0.

setVersionCore(long, long) - Method in class com.github.zafarkhaja.semver.Version.Builder

Sets the major and minor versions; the patch version is assigned 0.

setVersionCore(long, long, long) - Method in class com.github.zafarkhaja.semver.Version.Builder

Sets major, minor and patch versions.

Stream<E> - Class in com.github.zafarkhaja.semver.util

A simple stream class used to represent a stream of characters or tokens.

Stream(E[]) - Constructor for class com.github.zafarkhaja.semver.util.Stream

Constructs a stream containing the specified elements.

Stream.ElementType<E> - Interface in com.github.zafarkhaja.semver.util

The ElementType interface represents types of the elements held by this stream and can be used for stream filtering.

T

test(Version) - Method in interface com.github.zafarkhaja.semver.expr.Expression

 

toArray() - Method in class com.github.zafarkhaja.semver.util.Stream

Returns an array containing all of the elements that are left in this stream.

toBuilder() - Method in class com.github.zafarkhaja.semver.Version

Converts this Version to Builder.

toStableVersion() - Method in class com.github.zafarkhaja.semver.Version

Obtains the next Version by dropping the pre-release version.

toString() - Method in exception class com.github.zafarkhaja.semver.expr.LexerException

Returns the string representation of this exception.

toString() - Method in exception class com.github.zafarkhaja.semver.expr.UnexpectedTokenException

Returns the string representation of this exception containing the information about the unexpected token and, if available, about the expected types.

toString() - Method in exception class com.github.zafarkhaja.semver.ParseException

Returns the string representation of this exception.

toString() - Method in exception class com.github.zafarkhaja.semver.UnexpectedCharacterException

Returns the string representation of this exception containing the information about the unexpected element and, if available, about the expected types.

toString() - Method in exception class com.github.zafarkhaja.semver.util.UnexpectedElementException

Returns the string representation of this exception containing the information about the unexpected element and, if available, about the expected types.

toString() - Method in class com.github.zafarkhaja.semver.Version

tryParse(String) - Static method in class com.github.zafarkhaja.semver.Version

Tries to obtain a Version instance by parsing the specified string in strict mode, which ensures full compliance with the specification.

tryParse(String, boolean) - Static method in class com.github.zafarkhaja.semver.Version

Tries to obtain a Version instance by parsing the specified string.

U

UnexpectedCharacterException - Exception Class in com.github.zafarkhaja.semver

Thrown when attempting to consume a character of unexpected types.

UnexpectedElementException - Exception Class in com.github.zafarkhaja.semver.util

Thrown when attempting to consume a stream element of unexpected types.

UnexpectedTokenException - Exception Class in com.github.zafarkhaja.semver.expr

Thrown when a token of unexpected types is encountered during the parsing.

unsetBuildMetadata() - Method in class com.github.zafarkhaja.semver.Version.Builder

Unsets the build metadata.

unsetPreReleaseVersion() - Method in class com.github.zafarkhaja.semver.Version.Builder

Unsets the pre-release version.

V

valueOf(String) - Static method in class com.github.zafarkhaja.semver.Version

Deprecated.

forRemoval since 0.10.0, use Version.parse(String)

Version - Class in com.github.zafarkhaja.semver

A representation of version as defined by the SemVer Specification.

Version.Builder - Class in com.github.zafarkhaja.semver

A mutable builder for the immutable Version class

W

withBuildMetadata(String...) - Method in class com.github.zafarkhaja.semver.Version

Obtains a new Version with the specified build identifiers.

withoutBuildMetadata() - Method in class com.github.zafarkhaja.semver.Version

Obtains a (new) Version without build metadata.