ReflectionIT.PropertyThrowGenerator 0.1.2-beta

ReflectionIT.PropertyThrowGenerator

A source generator package that creates partial properties annotated with [ThrowIf...] attributes. The generated property setters throw an Argument...Exception when an invalid value is set.

NuGet package

Package	Version
ReflectionIT.PropertyThrowGenerator

Your project must use LangVersion C# 14.0 or higher because the generated code uses the new field keyword.

It must also target .NET 8.0 or higher because the generated code uses the ArgumentOutOfRangeException throw helper methods.

Example

Install the NuGet package and write the following code:

using ReflectionIT.PropertyThrowGenerator.Attributes;

partial class Employee {

    public Employee() {
    }

    [ThrowIfNull]
    public required partial string Name { get; set; }

    [ThrowIfNull]
    [ThrowIfGreaterThan("London")]
    public partial string City { get; set; } = string.Empty;

    [ThrowIfGreaterThanOrEqual(16)]
    public partial int Age { get; set; }

    // decimal type for attribute parameters are not support, use string instead
    [ThrowIfGreaterThan("1234.56M")] 
    [ThrowIfNegative]
    public partial decimal Salary { get; set; }

}

This generates the following partial class with four partial properties that validate the assigned value in their setters.

partial class Employee
{
    public required partial string Name {
        get;
        set {
            global::System.ArgumentNullException.ThrowIfNull(value);
            field = value;
        }
    }

    public partial string City {
        get;
        set {
            global::System.ArgumentNullException.ThrowIfNull(value);
            global::System.ArgumentOutOfRangeException.ThrowIfGreaterThan(value, "London");
            field = value;
        }
    }

    public partial int Age {
        get;
        set {
            global::System.ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual(value, 16);
            field = value;
        }
    }

    public partial decimal Salary {
        get;
        set {
            global::System.ArgumentOutOfRangeException.ThrowIfGreaterThan(value, 1234.56M);
            global::System.ArgumentOutOfRangeException.ThrowIfNegative(value);
            field = value;
        }
    }
}

Attributes

• ThrowIfEqualAttribute
• ThrowIfGreaterThanAttribute
• ThrowIfGreaterThanOrEqualAttribute
• ThrowIfLessThanAttribute
• ThrowIfLessThanOrEqualAttribute
• ThrowIfNegativeAttribute
• ThrowIfNegativeOrZeroAttribute
• ThrowIfNotEqualAttribute
• ThrowIfNullAttribute
• ThrowIfNullOrEmptyAttribute
• ThrowIfNullOrWhiteSpaceAttribute
• ThrowIfZeroAttribute

License

This project is licensed under the MIT License - see the LICENSE file for details.