ExceptionCondition<TException> Class

Definition

Namespace

Cuemon

Assemblies

Cuemon.Kernel.dll

Source

src/Cuemon.Kernel/ExceptionCondition.cs

Provides a fluent and generic way to setup a condition for raising an Exception.

public class ExceptionCondition<TException> where TException : Exception

Type Parameters

TException

The type of the Exception.

Inheritance

object

ExceptionCondition<TException>

Examples

The following example demonstrates how to use to fluently define a condition under which a specific exception should be thrown.

using System;
using Cuemon; // for ExceptionCondition

namespace MyApp.Examples;

public class ExceptionConditionExample
{
    public void Demonstrate()
    {
        // Throw InvalidOperationException only when a condition is true
        var invoker = new ExceptionCondition<InvalidOperationException>()
            .IsTrue(() => DateTime.Now.DayOfWeek == DayOfWeek.Monday)
            .Create(() => new InvalidOperationException("Cannot run this operation on Mondays."));

        // If today is Monday, TryThrow will throw InvalidOperationException
        // If today is not Monday, TryThrow does nothing
        invoker.TryThrow();

        // Throw ArgumentException only when a condition is false
        var falseInvoker = new ExceptionCondition<ArgumentException>()
            .IsFalse(() => Environment.UserName == "admin")
            .Create(() => new ArgumentException("Only admin can call this method."));

        falseInvoker.TryThrow();

        // Use the TesterFunc overload to pass data to the exception
        TesterFunc<string, bool> tryGetValue = (out string value) =>
        {
            value = "cached-data";
            return true; // data exists
        };

        var dataInvoker = new ExceptionCondition<InvalidOperationException>()
            .IsTrue(tryGetValue)
            .Create(data => new InvalidOperationException(
                $"Value '{data}' has expired. Please refresh."));

        // Since condition returns true, this throws
        dataInvoker.TryThrow();

}
}

Methods

Name	Description
IsFalse(Func<bool>)	Indicates that the specified function delegate condition must evaluate false.
IsFalse<TResult>(TesterFunc<TResult, bool>)	Indicates that the specified function delegate condition must evaluate false.
IsTrue(Func<bool>)	Indicates that the specified function delegate condition must evaluate true.
IsTrue<TResult>(TesterFunc<TResult, bool>)	Indicates that the specified function delegate condition must evaluate true.