Index
Date: 2017-02-08

A B C E F G H I L N O P S T U V

## A

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
  Builds a `Version` object.
BUILD_AWARE_ORDER - Static variable in class com.github.zafarkhaja.semver.Version
  A comparator that respects the build metadata when comparing versions.

## C

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 this version to the other version.
compareWithBuildsTo(Version) - Method in class com.github.zafarkhaja.semver.Version
  Compare this version to the other version taking into account the build metadata.
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.
CompositeExpression.Helper() - Constructor for class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper
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 equals the other 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
  Creates a new instance of `Version` for the specified version numbers.
forIntegers(int, int) - Static method in class com.github.zafarkhaja.semver.Version
  Creates a new instance of `Version` for the specified version numbers.
forIntegers(int, int, int) - Static method in class com.github.zafarkhaja.semver.Version
  Creates a new instance of `Version` for the specified version numbers.

## G

getBuildMetadata() - Method in class com.github.zafarkhaja.semver.Version
  Returns the string representation of the build metadata.
getExpectedElementTypes() - Method in exception com.github.zafarkhaja.semver.util.UnexpectedElementException
  Gets the expected element types.
getMajorVersion() - Method in class com.github.zafarkhaja.semver.Version
  Returns the major version number.
getMinorVersion() - Method in class com.github.zafarkhaja.semver.Version
  Returns the minor version number.
getNormalVersion() - Method in class com.github.zafarkhaja.semver.Version
  Returns the string representation of the normal version.
getPatchVersion() - Method in class com.github.zafarkhaja.semver.Version
  Returns the patch version number.
getPosition() - Method in exception com.github.zafarkhaja.semver.util.UnexpectedElementException
  Gets the position of the unexpected element.
getPreReleaseVersion() - Method in class com.github.zafarkhaja.semver.Version
  Returns the string representation of the pre-release version.
getUnexpectedElement() - Method in exception com.github.zafarkhaja.semver.util.UnexpectedElementException
  Gets the unexpected element.
greaterThan(Version) - Method in class com.github.zafarkhaja.semver.Version
  Checks if this version is greater than the other version.
greaterThanOrEqualTo(Version) - Method in class com.github.zafarkhaja.semver.Version
  Checks if this version is greater than or equal to the other 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

## I

incrementBuildMetadata() - Method in class com.github.zafarkhaja.semver.Version
  Increments the build metadata.
incrementMajorVersion() - Method in class com.github.zafarkhaja.semver.Version
  Increments the major version.
incrementMajorVersion(String) - Method in class com.github.zafarkhaja.semver.Version
  Increments the major version and appends the pre-release version.
incrementMinorVersion() - Method in class com.github.zafarkhaja.semver.Version
  Increments the minor version.
incrementMinorVersion(String) - Method in class com.github.zafarkhaja.semver.Version
  Increments the minor version and appends the pre-release version.
incrementPatchVersion() - Method in class com.github.zafarkhaja.semver.Version
  Increments the patch version.
incrementPatchVersion(String) - Method in class com.github.zafarkhaja.semver.Version
  Increments the patch version and appends the pre-release version.
incrementPreReleaseVersion() - Method in class com.github.zafarkhaja.semver.Version
  Increments the pre-release version.
interpret(String) - Method in class com.github.zafarkhaja.semver.expr.CompositeExpression
  Interprets the expression.
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.
isMatchedBy(E) - Method in interface com.github.zafarkhaja.semver.util.Stream.ElementType
  Checks if the specified element matches this type.
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
  Checks if this version is less than the other version.
lessThanOrEqualTo(Version) - Method in class com.github.zafarkhaja.semver.Version
  Checks if this version is less than or equal to the other version.
LexerException - Exception 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.

## 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.
not(Expression) - Static method in class com.github.zafarkhaja.semver.expr.CompositeExpression.Helper
  Creates a `CompositeExpression` with an underlying `Not` expression.

## O

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.
ParseException - Exception in com.github.zafarkhaja.semver
  Thrown to indicate an error during the parsing.
ParseException() - Constructor for exception com.github.zafarkhaja.semver.ParseException
  Constructs a `ParseException` instance with no error message.
ParseException(String) - Constructor for exception com.github.zafarkhaja.semver.ParseException
  Constructs a `ParseException` instance with an error message.
ParseException(String, UnexpectedCharacterException) - Constructor for exception 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.
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.
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 SemVer Expression string.
satisfies(Expression) - Method in class com.github.zafarkhaja.semver.Version
  Checks if this version satisfies the specified SemVer Expression.
setBuildMetadata(String) - Method in class com.github.zafarkhaja.semver.Version.Builder
  Sets the build metadata.
setBuildMetadata(String) - Method in class com.github.zafarkhaja.semver.Version
  Sets the build metadata.
setNormalVersion(String) - Method in class com.github.zafarkhaja.semver.Version.Builder
  Sets the normal version.
setPreReleaseVersion(String) - Method in class com.github.zafarkhaja.semver.Version.Builder
  Sets the pre-release version.
setPreReleaseVersion(String) - Method in class com.github.zafarkhaja.semver.Version
  Sets the pre-release version.
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

toArray() - Method in class com.github.zafarkhaja.semver.util.Stream
  Returns an array containing all of the elements that are left in this stream.
toString() - Method in exception com.github.zafarkhaja.semver.expr.LexerException
  Returns the string representation of this exception.
toString() - Method in exception 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 com.github.zafarkhaja.semver.ParseException
  Returns the string representation of this exception.
toString() - Method in exception 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 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

## U

UnexpectedCharacterException - Exception in com.github.zafarkhaja.semver
  Thrown when attempting to consume a character of unexpected types.
UnexpectedElementException - Exception in com.github.zafarkhaja.semver.util
  Thrown when attempting to consume a stream element of unexpected types.
UnexpectedTokenException - Exception in com.github.zafarkhaja.semver.expr
  Thrown when a token of unexpected types is encountered during the parsing.

## V

valueOf(String) - Static method in class com.github.zafarkhaja.semver.Version
  Creates a new instance of `Version` as a result of parsing the specified version string.
Version - Class in com.github.zafarkhaja.semver
  The `Version` class is the main class of the Java SemVer library.
Version.Builder - Class in com.github.zafarkhaja.semver
  A mutable builder for the immutable `Version` class.
Version.Builder() - Constructor for class com.github.zafarkhaja.semver.Version.Builder
  Constructs a `Builder` instance.
Version.Builder(String) - Constructor for class com.github.zafarkhaja.semver.Version.Builder
  Constructs a `Builder` instance with the string representation of the normal version.

A B C E F G H I L N O P S T U V