public static class GaxPreconditions
Preconditions for checking method arguments, state etc.
Namespace
Google.Api.GaxAssembly
Google.Api.Gax.dll
Methods
CheckArgument(bool, string, string)
public static void CheckArgument(bool condition, string paramName, string message)
Checks that given argument-based condition is met, throwing an ArgumentException otherwise.
condition
paramName
message
string
The message to include in the exception, if generated. This should not use interpolation, as the interpolation would be performed regardless of whether or not an exception is thrown.
CheckArgumentRange(int, string, int, int)
public static int CheckArgumentRange(int argument, string paramName, int minInclusive, int maxInclusive)
Checks that the given argument value is valid.
Note that the upper bound ( maxInclusive
) is inclusive,
not exclusive. This is deliberate, to allow the specification of ranges which include MaxValue
.
The argument was outside the specified range.
CheckArgumentRange<T>(T?, string, T, T)
public static T? CheckArgumentRange<T>(T? argument, string paramName, T minInclusive, T maxInclusive) where T : struct, IComparable<T>
Checks that the given argument value, if not null
, is valid.
argument
The value of the argument passed to the calling method.
paramName
minInclusive
T
The smallest valid value.
maxInclusive
T
The largest valid value.
argument
if it was in range, or null
.
T
Note that the upper bound ( maxInclusive
) is inclusive,
not exclusive. This is deliberate, to allow the specification of ranges which include MaxValue
.
The argument was outside the specified range.
CheckArgumentRange<T>(T, string, T, T)
public static T CheckArgumentRange<T>(T argument, string paramName, T minInclusive, T maxInclusive) where T : IComparable<T>
Checks that the given argument value is valid.
argument
T
The value of the argument passed to the calling method.
paramName
minInclusive
T
The smallest valid value.
maxInclusive
T
The largest valid value.
T
argument
if it was in range
T
Note that the upper bound ( maxInclusive
) is inclusive,
not exclusive. This is deliberate, to allow the specification of ranges which include MaxValue
.
The argument was outside the specified range.
CheckArgument<T>(bool, string, string, T)
public static void CheckArgument<T>(bool condition, string paramName, string format, T arg0)
Checks that given argument-based condition is met, throwing an ArgumentException otherwise.
condition
paramName
format
arg0
T
The argument to the format string.
T
CheckArgument<T1, T2>(bool, string, string, T1, T2)
public static void CheckArgument<T1, T2>(bool condition, string paramName, string format, T1 arg0, T2 arg1)
Checks that given argument-based condition is met, throwing an ArgumentException otherwise.
condition
paramName
format
arg0
T1
The first argument to the format string.
arg1
T2
The second argument to the format string.
T1
T2
CheckEnumValue<T>(T, string)
public static T CheckEnumValue<T>(T value, string paramName) where T : struct
Checks that the given value is in fact defined in the enum used as the type argument of the method.
value
T
The value to check.
paramName
T
value
if it was a defined value
T
The enum type to check the value within.
CheckNonNegative(double, string)
public static double CheckNonNegative(double argument, string paramName)
Checks that the given argument value is not negative.
CheckNonNegative(int, string)
public static int CheckNonNegative(int argument, string paramName)
Checks that the given argument value is not negative.
CheckNonNegative(long, string)
public static long CheckNonNegative(long argument, string paramName)
Checks that the given argument value is not negative.
CheckNonNegative(double?, string)
public static double? CheckNonNegative(double? argument, string paramName)
Checks that the given argument value, if not null
, is not negative.
CheckNonNegative(int?, string)
public static int? CheckNonNegative(int? argument, string paramName)
Checks that the given argument value, if not null
, is not negative.
CheckNonNegative(long?, string)
public static long? CheckNonNegative(long? argument, string paramName)
Checks that the given argument value, if not null
, is not negative.
CheckNonNegativeDelay(TimeSpan, string)
public static TimeSpan CheckNonNegativeDelay(TimeSpan value, string paramName)
Checks that the given TimeSpan used as a delay is non-negative. This is a very specific call; most users won't need it.
CheckNotNullOrEmpty(string, string)
public static string CheckNotNullOrEmpty(string argument, string paramName)
Checks that a string argument is neither null, nor an empty string.
argument
is null
argument
is empty
CheckNotNull<T>(T, string)
public static T CheckNotNull<T>(T argument, string paramName) where T : class
Checks that the given argument (to the calling method) is non-null.
argument
T
The argument provided for the parameter.
paramName
T
argument
if it is not null
T
The type of the parameter.
CheckState(bool, string)
public static void CheckState(bool condition, string message)
Checks that given condition is met, throwing an InvalidOperationException otherwise.
CheckState<T>(bool, string, T)
public static void CheckState<T>(bool condition, string format, T arg0)
Checks that given condition is met, throwing an InvalidOperationException otherwise.
T
CheckState<T1, T2>(bool, string, T1, T2)
public static void CheckState<T1, T2>(bool condition, string format, T1 arg0, T2 arg1)
Checks that given condition is met, throwing an InvalidOperationException otherwise.
T1
T2
CheckState<T1, T2, T3>(bool, string, T1, T2, T3)
public static void CheckState<T1, T2, T3>(bool condition, string format, T1 arg0, T2 arg1, T3 arg2)
Checks that given condition is met, throwing an InvalidOperationException otherwise.
condition
format
arg0
T1
The first argument to the format string.
arg1
T2
The second argument to the format string.
arg2
T3
The third argument to the format string.
T1
T2
T3
