NextVersion Class

Summary

Represents the next calculated version together with its base version and branch configuration.
Assembly
GitVersion.Core.dll
Namespace
GitVersion.VersionCalculation
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IComparable<NextVersion>"] Type-.->Interface1["IEquatable<NextVersion>"] Type["NextVersion"] class Type type-node

Syntax

public sealed class NextVersion : IComparable<NextVersion>, IEquatable<NextVersion>

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Name Summary
NextVersion(SemanticVersion, IBaseVersion, EffectiveBranchConfiguration) Represents the next calculated version together with its base version and branch configuration.

Properties

Name Value Summary
BaseVersion IBaseVersion
Gets the base version that was used as the starting point for this calculation.
BranchConfiguration EffectiveBranchConfiguration
Gets the effective branch configuration under which this version was calculated.
Configuration EffectiveConfiguration
Gets the effective configuration values for the branch.
IncrementedVersion SemanticVersion
Gets the semantic version after applying the required increments.

Methods

Name Value Summary
CompareTo(NextVersion) int
Compares this version to other by incremented version.
Equals(NextVersion) bool
Returns true when this instance equals other.
Equals(object) bool
Returns true when obj is a NextVersion equal to this instance.
GetHashCode() int
Returns a hash code based on the string representation.
ToString() string
Returns a human-readable representation showing the base version and incremented version.

Operators

Name Value Summary
operator !=(NextVersion, NextVersion) bool
operator <(NextVersion, NextVersion) bool
operator <=(NextVersion, NextVersion) bool
operator ==(NextVersion, NextVersion) bool
operator >(NextVersion, NextVersion) bool
operator >=(NextVersion, NextVersion) bool

Extension Methods

Name Value Summary
NotNull<NextVersion>(string) T
Throws System.ArgumentNullException when value is null; otherwise returns the value.