|
| 1 | +using System; |
| 2 | + |
| 3 | +namespace OpenFeature.Model |
| 4 | +{ |
| 5 | + /// <summary> |
| 6 | + /// A builder which allows the specification of attributes for an <see cref="TrackingEventDetails"/>. |
| 7 | + /// <para> |
| 8 | + /// A <see cref="TrackingEventDetailsBuilder"/> object is intended for use by a single thread and should not be used |
| 9 | + /// from multiple threads. Once an <see cref="TrackingEventDetails"/> has been created it is immutable and safe for use |
| 10 | + /// from multiple threads. |
| 11 | + /// </para> |
| 12 | + /// </summary> |
| 13 | + public sealed class TrackingEventDetailsBuilder |
| 14 | + { |
| 15 | + private readonly StructureBuilder _attributes = Structure.Builder(); |
| 16 | + private double? _value; |
| 17 | + |
| 18 | + /// <summary> |
| 19 | + /// Internal to only allow direct creation by <see cref="TrackingEventDetails.Builder()"/>. |
| 20 | + /// </summary> |
| 21 | + internal TrackingEventDetailsBuilder() { } |
| 22 | + |
| 23 | + /// <summary> |
| 24 | + /// Set the predefined value field for the tracking details. |
| 25 | + /// </summary> |
| 26 | + /// <param name="value"></param> |
| 27 | + /// <returns></returns> |
| 28 | + public TrackingEventDetailsBuilder SetValue(double? value) |
| 29 | + { |
| 30 | + this._value = value; |
| 31 | + return this; |
| 32 | + } |
| 33 | + |
| 34 | + /// <summary> |
| 35 | + /// Set the key to the given <see cref="Value"/>. |
| 36 | + /// </summary> |
| 37 | + /// <param name="key">The key for the value</param> |
| 38 | + /// <param name="value">The value to set</param> |
| 39 | + /// <returns>This builder</returns> |
| 40 | + public TrackingEventDetailsBuilder Set(string key, Value value) |
| 41 | + { |
| 42 | + this._attributes.Set(key, value); |
| 43 | + return this; |
| 44 | + } |
| 45 | + |
| 46 | + /// <summary> |
| 47 | + /// Set the key to the given string. |
| 48 | + /// </summary> |
| 49 | + /// <param name="key">The key for the value</param> |
| 50 | + /// <param name="value">The value to set</param> |
| 51 | + /// <returns>This builder</returns> |
| 52 | + public TrackingEventDetailsBuilder Set(string key, string value) |
| 53 | + { |
| 54 | + this._attributes.Set(key, value); |
| 55 | + return this; |
| 56 | + } |
| 57 | + |
| 58 | + /// <summary> |
| 59 | + /// Set the key to the given int. |
| 60 | + /// </summary> |
| 61 | + /// <param name="key">The key for the value</param> |
| 62 | + /// <param name="value">The value to set</param> |
| 63 | + /// <returns>This builder</returns> |
| 64 | + public TrackingEventDetailsBuilder Set(string key, int value) |
| 65 | + { |
| 66 | + this._attributes.Set(key, value); |
| 67 | + return this; |
| 68 | + } |
| 69 | + |
| 70 | + /// <summary> |
| 71 | + /// Set the key to the given double. |
| 72 | + /// </summary> |
| 73 | + /// <param name="key">The key for the value</param> |
| 74 | + /// <param name="value">The value to set</param> |
| 75 | + /// <returns>This builder</returns> |
| 76 | + public TrackingEventDetailsBuilder Set(string key, double value) |
| 77 | + { |
| 78 | + this._attributes.Set(key, value); |
| 79 | + return this; |
| 80 | + } |
| 81 | + |
| 82 | + /// <summary> |
| 83 | + /// Set the key to the given long. |
| 84 | + /// </summary> |
| 85 | + /// <param name="key">The key for the value</param> |
| 86 | + /// <param name="value">The value to set</param> |
| 87 | + /// <returns>This builder</returns> |
| 88 | + public TrackingEventDetailsBuilder Set(string key, long value) |
| 89 | + { |
| 90 | + this._attributes.Set(key, value); |
| 91 | + return this; |
| 92 | + } |
| 93 | + |
| 94 | + /// <summary> |
| 95 | + /// Set the key to the given bool. |
| 96 | + /// </summary> |
| 97 | + /// <param name="key">The key for the value</param> |
| 98 | + /// <param name="value">The value to set</param> |
| 99 | + /// <returns>This builder</returns> |
| 100 | + public TrackingEventDetailsBuilder Set(string key, bool value) |
| 101 | + { |
| 102 | + this._attributes.Set(key, value); |
| 103 | + return this; |
| 104 | + } |
| 105 | + |
| 106 | + /// <summary> |
| 107 | + /// Set the key to the given <see cref="Structure"/>. |
| 108 | + /// </summary> |
| 109 | + /// <param name="key">The key for the value</param> |
| 110 | + /// <param name="value">The value to set</param> |
| 111 | + /// <returns>This builder</returns> |
| 112 | + public TrackingEventDetailsBuilder Set(string key, Structure value) |
| 113 | + { |
| 114 | + this._attributes.Set(key, value); |
| 115 | + return this; |
| 116 | + } |
| 117 | + |
| 118 | + /// <summary> |
| 119 | + /// Set the key to the given DateTime. |
| 120 | + /// </summary> |
| 121 | + /// <param name="key">The key for the value</param> |
| 122 | + /// <param name="value">The value to set</param> |
| 123 | + /// <returns>This builder</returns> |
| 124 | + public TrackingEventDetailsBuilder Set(string key, DateTime value) |
| 125 | + { |
| 126 | + this._attributes.Set(key, value); |
| 127 | + return this; |
| 128 | + } |
| 129 | + |
| 130 | + /// <summary> |
| 131 | + /// Incorporate existing tracking details into the builder. |
| 132 | + /// <para> |
| 133 | + /// Any existing keys in the builder will be replaced by keys in the tracking details, including the Value set |
| 134 | + /// through <see cref="SetValue(double?)"/>. |
| 135 | + /// </para> |
| 136 | + /// </summary> |
| 137 | + /// <param name="trackingDetails">The tracking details to add merge</param> |
| 138 | + /// <returns>This builder</returns> |
| 139 | + public TrackingEventDetailsBuilder Merge(TrackingEventDetails trackingDetails) |
| 140 | + { |
| 141 | + this._value = trackingDetails.Value; |
| 142 | + foreach (var kvp in trackingDetails) |
| 143 | + { |
| 144 | + this.Set(kvp.Key, kvp.Value); |
| 145 | + } |
| 146 | + |
| 147 | + return this; |
| 148 | + } |
| 149 | + |
| 150 | + /// <summary> |
| 151 | + /// Build an immutable <see cref="TrackingEventDetails"/>. |
| 152 | + /// </summary> |
| 153 | + /// <returns>An immutable <see cref="TrackingEventDetails"/></returns> |
| 154 | + public TrackingEventDetails Build() |
| 155 | + { |
| 156 | + return new TrackingEventDetails(this._attributes.Build(), this._value); |
| 157 | + } |
| 158 | + } |
| 159 | +} |
0 commit comments