Skip to content

Commit 18d73c5

Browse files
mic-maxcijothomas
mic-max
and
cijothomas
authored
Make Guard method names more explicit (#2762)
Co-authored-by: Cijo Thomas <[email protected]>
1 parent fc35311 commit 18d73c5

File tree

81 files changed

+205
-205
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+205
-205
lines changed

‎src/OpenTelemetry.Api/Baggage.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ public IReadOnlyDictionary<string, string> GetBaggage()
239239
/// <returns>Baggage item or <see langword="null"/> if nothing was found.</returns>
240240
public string GetBaggage(string name)
241241
{
242-
Guard.NullOrEmpty(name, nameof(name));
242+
Guard.ThrowIfNullOrEmpty(name, nameof(name));
243243

244244
return this.baggage != null && this.baggage.TryGetValue(name, out string value)
245245
? value

‎src/OpenTelemetry.Api/Context/Propagation/CompositeTextMapPropagator.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public class CompositeTextMapPropagator : TextMapPropagator
3535
/// <param name="propagators">List of <see cref="TextMapPropagator"/> wire context propagator.</param>
3636
public CompositeTextMapPropagator(IEnumerable<TextMapPropagator> propagators)
3737
{
38-
Guard.Null(propagators, nameof(propagators));
38+
Guard.ThrowIfNull(propagators, nameof(propagators));
3939

4040
this.propagators = new List<TextMapPropagator>(propagators);
4141
}

‎src/OpenTelemetry.Api/Context/RuntimeContext.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public static class RuntimeContext
4141
/// <returns>The slot registered.</returns>
4242
public static RuntimeContextSlot<T> RegisterSlot<T>(string slotName)
4343
{
44-
Guard.NullOrEmpty(slotName, nameof(slotName));
44+
Guard.ThrowIfNullOrEmpty(slotName, nameof(slotName));
4545

4646
lock (Slots)
4747
{
@@ -66,9 +66,9 @@ public static RuntimeContextSlot<T> RegisterSlot<T>(string slotName)
6666
/// <returns>The slot previously registered.</returns>
6767
public static RuntimeContextSlot<T> GetSlot<T>(string slotName)
6868
{
69-
Guard.NullOrEmpty(slotName, nameof(slotName));
69+
Guard.ThrowIfNullOrEmpty(slotName, nameof(slotName));
7070
var slot = GuardNotFound(slotName);
71-
var contextSlot = Guard.Type<RuntimeContextSlot<T>>(slot, nameof(slot));
71+
var contextSlot = Guard.ThrowIfNotOfType<RuntimeContextSlot<T>>(slot, nameof(slot));
7272
return contextSlot;
7373
}
7474

@@ -127,9 +127,9 @@ public static T GetValue<T>(string slotName)
127127
/// <param name="value">The value to be set.</param>
128128
public static void SetValue(string slotName, object value)
129129
{
130-
Guard.NullOrEmpty(slotName, nameof(slotName));
130+
Guard.ThrowIfNullOrEmpty(slotName, nameof(slotName));
131131
var slot = GuardNotFound(slotName);
132-
var runtimeContextSlotValueAccessor = Guard.Type<IRuntimeContextSlotValueAccessor>(slot, nameof(slot));
132+
var runtimeContextSlotValueAccessor = Guard.ThrowIfNotOfType<IRuntimeContextSlotValueAccessor>(slot, nameof(slot));
133133
runtimeContextSlotValueAccessor.Value = value;
134134
}
135135

@@ -140,9 +140,9 @@ public static void SetValue(string slotName, object value)
140140
/// <returns>The value retrieved from the context slot.</returns>
141141
public static object GetValue(string slotName)
142142
{
143-
Guard.NullOrEmpty(slotName, nameof(slotName));
143+
Guard.ThrowIfNullOrEmpty(slotName, nameof(slotName));
144144
var slot = GuardNotFound(slotName);
145-
var runtimeContextSlotValueAccessor = Guard.Type<IRuntimeContextSlotValueAccessor>(slot, nameof(slot));
145+
var runtimeContextSlotValueAccessor = Guard.ThrowIfNotOfType<IRuntimeContextSlotValueAccessor>(slot, nameof(slot));
146146
return runtimeContextSlotValueAccessor.Value;
147147
}
148148

‎src/OpenTelemetry.Api/Internal/Guard.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ internal static class Guard
3535
/// <param name="paramName">The parameter name to use in the thrown exception.</param>
3636
[DebuggerHidden]
3737
[MethodImpl(MethodImplOptions.AggressiveInlining)]
38-
public static void Null(object value, string paramName = DefaultParamName)
38+
public static void ThrowIfNull(object value, string paramName = DefaultParamName)
3939
{
4040
if (value is null)
4141
{
@@ -50,7 +50,7 @@ public static void Null(object value, string paramName = DefaultParamName)
5050
/// <param name="paramName">The parameter name to use in the thrown exception.</param>
5151
[DebuggerHidden]
5252
[MethodImpl(MethodImplOptions.AggressiveInlining)]
53-
public static void NullOrEmpty(string value, string paramName = DefaultParamName)
53+
public static void ThrowIfNullOrEmpty(string value, string paramName = DefaultParamName)
5454
{
5555
if (string.IsNullOrEmpty(value))
5656
{
@@ -65,7 +65,7 @@ public static void NullOrEmpty(string value, string paramName = DefaultParamName
6565
/// <param name="paramName">The parameter name to use in the thrown exception.</param>
6666
[DebuggerHidden]
6767
[MethodImpl(MethodImplOptions.AggressiveInlining)]
68-
public static void NullOrWhitespace(string value, string paramName = DefaultParamName)
68+
public static void ThrowIfNullOrWhitespace(string value, string paramName = DefaultParamName)
6969
{
7070
if (string.IsNullOrWhiteSpace(value))
7171
{
@@ -81,7 +81,7 @@ public static void NullOrWhitespace(string value, string paramName = DefaultPara
8181
/// <param name="paramName">The parameter name to use in the thrown exception.</param>
8282
[DebuggerHidden]
8383
[MethodImpl(MethodImplOptions.AggressiveInlining)]
84-
public static void Zero(int value, string message = "Must not be zero", string paramName = DefaultParamName)
84+
public static void ThrowIfZero(int value, string message = "Must not be zero", string paramName = DefaultParamName)
8585
{
8686
if (value == 0)
8787
{
@@ -96,9 +96,9 @@ public static void Zero(int value, string message = "Must not be zero", string p
9696
/// <param name="paramName">The parameter name to use in the thrown exception.</param>
9797
[DebuggerHidden]
9898
[MethodImpl(MethodImplOptions.AggressiveInlining)]
99-
public static void InvalidTimeout(int value, string paramName = DefaultParamName)
99+
public static void ThrowIfInvalidTimeout(int value, string paramName = DefaultParamName)
100100
{
101-
Range(value, paramName, min: Timeout.Infinite, message: $"Must be non-negative or '{nameof(Timeout)}.{nameof(Timeout.Infinite)}'");
101+
ThrowIfOutOfRange(value, paramName, min: Timeout.Infinite, message: $"Must be non-negative or '{nameof(Timeout)}.{nameof(Timeout.Infinite)}'");
102102
}
103103

104104
/// <summary>
@@ -113,9 +113,9 @@ public static void InvalidTimeout(int value, string paramName = DefaultParamName
113113
/// <param name="message">An optional custom message to use in the thrown exception.</param>
114114
[DebuggerHidden]
115115
[MethodImpl(MethodImplOptions.AggressiveInlining)]
116-
public static void Range(int value, string paramName = DefaultParamName, int min = int.MinValue, int max = int.MaxValue, string minName = null, string maxName = null, string message = null)
116+
public static void ThrowIfOutOfRange(int value, string paramName = DefaultParamName, int min = int.MinValue, int max = int.MaxValue, string minName = null, string maxName = null, string message = null)
117117
{
118-
Range<int>(value, paramName, min, max, minName, maxName, message);
118+
Range(value, paramName, min, max, minName, maxName, message);
119119
}
120120

121121
/// <summary>
@@ -130,9 +130,9 @@ public static void Range(int value, string paramName = DefaultParamName, int min
130130
/// <param name="message">An optional custom message to use in the thrown exception.</param>
131131
[DebuggerHidden]
132132
[MethodImpl(MethodImplOptions.AggressiveInlining)]
133-
public static void Range(double value, string paramName = DefaultParamName, double min = double.MinValue, double max = double.MaxValue, string minName = null, string maxName = null, string message = null)
133+
public static void ThrowIfOutOfRange(double value, string paramName = DefaultParamName, double min = double.MinValue, double max = double.MaxValue, string minName = null, string maxName = null, string message = null)
134134
{
135-
Range<double>(value, paramName, min, max, minName, maxName, message);
135+
Range(value, paramName, min, max, minName, maxName, message);
136136
}
137137

138138
/// <summary>
@@ -144,7 +144,7 @@ public static void Range(double value, string paramName = DefaultParamName, doub
144144
/// <returns>The value casted to the specified type.</returns>
145145
[DebuggerHidden]
146146
[MethodImpl(MethodImplOptions.AggressiveInlining)]
147-
public static T Type<T>(object value, string paramName = DefaultParamName)
147+
public static T ThrowIfNotOfType<T>(object value, string paramName = DefaultParamName)
148148
{
149149
if (value is not T result)
150150
{

‎src/OpenTelemetry.Api/Trace/SpanAttributes.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public SpanAttributes()
4141
public SpanAttributes(IEnumerable<KeyValuePair<string, object>> attributes)
4242
: this()
4343
{
44-
Guard.Null(attributes, nameof(attributes));
44+
Guard.ThrowIfNull(attributes, nameof(attributes));
4545

4646
foreach (KeyValuePair<string, object> kvp in attributes)
4747
{
@@ -133,7 +133,7 @@ public void Add(string key, double[] values)
133133

134134
private void AddInternal(string key, object value)
135135
{
136-
Guard.Null(key, nameof(key));
136+
Guard.ThrowIfNull(key, nameof(key));
137137

138138
this.Attributes[key] = value;
139139
}

‎src/OpenTelemetry.Exporter.Console/ConsoleExporterHelperExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public static class ConsoleExporterHelperExtensions
3131
[System.Diagnostics.CodeAnalysis.SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "The objects should not be disposed.")]
3232
public static TracerProviderBuilder AddConsoleExporter(this TracerProviderBuilder builder, Action<ConsoleExporterOptions> configure = null)
3333
{
34-
Guard.Null(builder, nameof(builder));
34+
Guard.ThrowIfNull(builder, nameof(builder));
3535

3636
if (builder is IDeferredTracerProviderBuilder deferredTracerProviderBuilder)
3737
{

‎src/OpenTelemetry.Exporter.Console/ConsoleExporterLoggingExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public static class ConsoleExporterLoggingExtensions
3030
/// <returns>The instance of <see cref="OpenTelemetryLoggerOptions"/> to chain the calls.</returns>
3131
public static OpenTelemetryLoggerOptions AddConsoleExporter(this OpenTelemetryLoggerOptions loggerOptions, Action<ConsoleExporterOptions> configure = null)
3232
{
33-
Guard.Null(loggerOptions, nameof(loggerOptions));
33+
Guard.ThrowIfNull(loggerOptions, nameof(loggerOptions));
3434

3535
var options = new ConsoleExporterOptions();
3636
configure?.Invoke(options);

‎src/OpenTelemetry.Exporter.Console/ConsoleExporterMetricsExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public static class ConsoleExporterMetricsExtensions
3131
[System.Diagnostics.CodeAnalysis.SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "The objects should not be disposed.")]
3232
public static MeterProviderBuilder AddConsoleExporter(this MeterProviderBuilder builder, Action<ConsoleExporterOptions> configure = null)
3333
{
34-
Guard.Null(builder, nameof(builder));
34+
Guard.ThrowIfNull(builder, nameof(builder));
3535

3636
var options = new ConsoleExporterOptions();
3737
configure?.Invoke(options);

‎src/OpenTelemetry.Exporter.InMemory/InMemoryExporterHelperExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public static class InMemoryExporterHelperExtensions
3232
[System.Diagnostics.CodeAnalysis.SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "The objects should not be disposed.")]
3333
public static TracerProviderBuilder AddInMemoryExporter(this TracerProviderBuilder builder, ICollection<Activity> exportedItems)
3434
{
35-
Guard.Null(builder, nameof(builder));
36-
Guard.Null(exportedItems, nameof(exportedItems));
35+
Guard.ThrowIfNull(builder, nameof(builder));
36+
Guard.ThrowIfNull(exportedItems, nameof(exportedItems));
3737

3838
if (builder is IDeferredTracerProviderBuilder deferredTracerProviderBuilder)
3939
{

‎src/OpenTelemetry.Exporter.InMemory/InMemoryExporterLoggingExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ public static class InMemoryExporterLoggingExtensions
2424
{
2525
public static OpenTelemetryLoggerOptions AddInMemoryExporter(this OpenTelemetryLoggerOptions loggerOptions, ICollection<LogRecord> exportedItems)
2626
{
27-
Guard.Null(loggerOptions, nameof(loggerOptions));
28-
Guard.Null(exportedItems, nameof(exportedItems));
27+
Guard.ThrowIfNull(loggerOptions, nameof(loggerOptions));
28+
Guard.ThrowIfNull(exportedItems, nameof(exportedItems));
2929

3030
return loggerOptions.AddProcessor(new SimpleLogRecordExportProcessor(new InMemoryExporter<LogRecord>(exportedItems)));
3131
}

0 commit comments

Comments
 (0)