solid-instruments/src/RapidField.SolidInstruments.Core/ISemanticVersion.cs at master · RapidField/solid-instruments · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// =================================================================================================================================
// Copyright (c) RapidField LLC. Licensed under the MIT License. See LICENSE.txt in the project root for license information.
// =================================================================================================================================

using System;

namespace RapidField.SolidInstruments.Core
{
    /// <summary>
    /// Represents a version identifier that is compliant with the Semantic Versioning Specification (SemVer 2.0.0).
    /// </summary>
    public interface ISemanticVersion : ICloneable, IComparable<ISemanticVersion>, IEquatable<ISemanticVersion>
    {
        /// <summary>
        /// Gets the build metadata, <see langword="null" /> if there is no metadata.
        /// </summary>
        public String BuildMetadata
        {
            get;
        }

        /// <summary>
        /// Gets a value indicating whether or not the current <see cref="ISemanticVersion" /> includes build metadata.
        /// </summary>
        public Boolean HasBuildMetadata
        {
            get;
        }

        /// <summary>
        /// Gets a value indicating whether or not the current <see cref="ISemanticVersion" /> represents a new major version (eg.
        /// x.0.0).
        /// </summary>
        public Boolean IsMajor
        {
            get;
        }

        /// <summary>
        /// Gets a value indicating whether or not the current <see cref="ISemanticVersion" /> represents a new minor version (eg.
        /// x.x.0).
        /// </summary>
        public Boolean IsMinor
        {
            get;
        }

        /// <summary>
        /// Gets a value indicating whether or not the current <see cref="ISemanticVersion" /> represents a patch version (
        /// <see cref="PatchVersion" /> is greater than zero).
        /// </summary>
        public Boolean IsPatch
        {
            get;
        }

        /// <summary>
        /// Gets a value indicating whether or not the current <see cref="ISemanticVersion" /> represents a pre-release version.
        /// </summary>
        public Boolean IsPreRelease
        {
            get;
        }

        /// <summary>
        /// Gets a value indicating whether or not the current <see cref="ISemanticVersion" /> represents a stable version.
        /// </summary>
        public Boolean IsStable
        {
            get;
        }

        /// <summary>
        /// Gets the major version number, which is incremented for compatibility-breaking feature changes.
        /// </summary>
        public UInt64 MajorVersion
        {
            get;
        }

        /// <summary>
        /// Gets the minor version number, which is incremented for compatibility-retaining feature changes.
        /// </summary>
        public UInt64 MinorVersion
        {
            get;
        }

        /// <summary>
        /// Gets the patch version number, which is incremented for compatibility-retaining bug fix changes.
        /// </summary>
        public UInt64 PatchVersion
        {
            get;
        }

        /// <summary>
        /// Gets the pre-release label, or <see langword="null" /> if there is no label.
        /// </summary>
        public String PreReleaseLabel
        {
            get;
        }
    }
}