Interface IFluentBase

Serves as a foundational class for fluent interface pattern error handling, enabling mechanisms for both error accumulation and immediate exception throwing, alongside optional continuation after encountering validation errors. This abstract class standardizes error management for classes utilizing fluent interfaces.

Namespace: Coree.NETStandard.Abstractions.FluentBase

Assembly: Coree.NETStandard.dll

Syntax

public interface IFluentBase

Remarks

Implements IFluentBase, offering:

• Error accumulation during operations.
• Conditional continuation of operations post-errors.
• Flexible toggling between immediate exception throwing or error accumulation, adapting to various error handling strategies.

Examples

Illustrates the use of FluentBase with a concrete Product class and an extension method for price adjustment with comprehensive error handling:

public abstract class FluentBase : IFluentBase
{
    private bool throwOnError = true;
    public List<Exception> ValidationErrors { get; private set; } = new List<Exception>();
    public bool IsValid => !ValidationErrors.Any();
    public bool ContinueOnValidationError { get; private set; } = false;

    public void AddValidationError(string message, Exception innerException)
    {
        ValidationErrors.Add(new Exception(message, innerException));
        if (throwOnError)
        {
            throw innerException;
        }
    }

    public IFluentBase EnableThrowOnError()
    {
        throwOnError = true;
        ContinueOnValidationError = false;
        return this;
    }

    public IFluentBase DisableThrowOnError(bool continueOnValidationError = false)
    {
        throwOnError = false;
        ContinueOnValidationError = continueOnValidationError;
        return this;
    }
}

// Simplified Product class inheriting FluentBase
public class Product : FluentBase
{
    public string Name { get; set; }
    public decimal Price { get; set; }
}

// Extension method for Product
public static class ProductExtensions
{
    public static Product AdjustPrice(this Product product, decimal adjustment)
    {
        if (!product.IsValid && !product.ContinueOnValidationError) return product;

        try
        {
            var newPrice = product.Price + adjustment;
            if (newPrice < 0)
            {
                throw new ArgumentOutOfRangeException(nameof(adjustment), "Adjustment results in a negative price.");
            }
            product.Price = newPrice;
        }
        catch (Exception ex)
        {
            product.AddValidationError($"Error adjusting price by {adjustment}: {ex.Message}", ex);
        }

        return product;
    }
}

Properties

ContinueOnValidationError

Indicates whether operations should continue after a validation error has occurred.

Declaration

bool ContinueOnValidationError { get; }

Property Value

Type	Description
bool

IsValid

Indicates whether the current object is in a valid state.

Declaration

bool IsValid { get; }

Property Value

Type	Description
bool

ValidationErrors

A collection of exceptions that have been accumulated during operations.

Declaration

List<Exception> ValidationErrors { get; }

Property Value

Type	Description
List<Exception>

Methods

AddValidationError(string, Exception)

Adds a validation error to the collection with a custom message and the exception that occurred.

Declaration

void AddValidationError(string message, Exception innerException)

Parameters

Type	Name	Description
string	message	The error message.
Exception	innerException	The exception that occurred during validation.

DisableThrowOnError(bool)

Disables the behavior of throwing exceptions immediately, allowing operations to accumulate validation errors. Optionally allows continuation after validation errors based on the continueOnValidationError parameter.

Declaration

IFluentBase DisableThrowOnError(bool continueOnValidationError = false)

Parameters

Type	Name	Description
bool	continueOnValidationError	Determines whether to continue operations after a validation error has occurred.

Returns

Type	Description
IFluentBase	The current instance of IFluentBase.

EnableThrowOnError()

Enables the behavior to throw exceptions immediately when a validation error occurs. Resets ContinueOnValidationError to false.

Declaration

IFluentBase EnableThrowOnError()

Returns

Type	Description
IFluentBase	The current instance of IFluentBase.