Class ValidationResult

Namespace

Admonish

Assembly

Admonish.dll

Represents a collection of errors accumulated during validation.

public class ValidationResult

Inheritance

object

ValidationResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

DateTimeValidationExtensions.Between(ValidationResult, string, DateTime, DateTime, DateTime, string?)

DateTimeValidationExtensions.Between(ValidationResult, string, DateTimeOffset, DateTimeOffset, DateTimeOffset, string?)

DateTimeValidationExtensions.Max(ValidationResult, string, DateTime, DateTime, string?)

DateTimeValidationExtensions.Max(ValidationResult, string, DateTimeOffset, DateTimeOffset, string?)

DateTimeValidationExtensions.Min(ValidationResult, string, DateTime, DateTime, string?)

DateTimeValidationExtensions.Min(ValidationResult, string, DateTimeOffset, DateTimeOffset, string?)

EnumValidationExtensions.IsDefined<TEnum>(ValidationResult, string, TEnum, string?)

NumericValidationExtensions.Between(ValidationResult, string, decimal, decimal, decimal, string?)

NumericValidationExtensions.Between(ValidationResult, string, int, int, int, string?)

NumericValidationExtensions.Max(ValidationResult, string, decimal, decimal, string?)

NumericValidationExtensions.Max(ValidationResult, string, int, int, string?)

NumericValidationExtensions.Min(ValidationResult, string, decimal, decimal, string?)

NumericValidationExtensions.Min(ValidationResult, string, int, int, string?)

ObjectValidationExtensions.Equal<T>(ValidationResult, string, T, T, string?)

ObjectValidationExtensions.NonNull<T>(ValidationResult, string, T?, string?)

ObjectValidationExtensions.NonNull<T>(ValidationResult, string, T?, string?)

ObjectValidationExtensions.NotEqual<T>(ValidationResult, string, T, T, string?)

ObjectValidationExtensions.Null<T>(ValidationResult, string, T?, string?)

ObjectValidationExtensions.Null<T>(ValidationResult, string, T?, string?)

StringValidationExtensions.LengthBetween(ValidationResult, string, string?, int, int, string?)

StringValidationExtensions.Matches(ValidationResult, string, string?, Regex, string?)

StringValidationExtensions.NonNullOrEmpty(ValidationResult, string, string?, string?)

StringValidationExtensions.NonNullOrWhiteSpace(ValidationResult, string, string?, string?)

ValidationExtensions.Check(ValidationResult, bool, string)

ValidationExtensions.Check(ValidationResult, string, bool, string)

ValidationExtensions.Collection<T>(ValidationResult, string, IEnumerable<T>, Func<ValidationResult, T, ValidationResult>)

ValidationExtensions.WithKey(ValidationResult, string, Func<ValidationResult, ValidationResult>)

Constructors

ValidationResult(Func<ValidationResult, Exception>)

Initializes a new instance of the ValidationResult class with the specified validation exception factory.

public ValidationResult(Func<ValidationResult, Exception> exceptionFactory)

Parameters

exceptionFactory Func<ValidationResult, Exception>

When called, creates an exception to throw when a validation error occurs.

Fields

NoKey

The default key with which errors are associated when no key is specified.

public const string NoKey = "_"

Field Value

string

Properties

Success

A flag indicating whether validation was successful.

public bool Success { get; }

Property Value

bool

Methods

AddError(string)

Adds the specified error message to the collection.

public ValidationResult AddError(string error)

Parameters

error string

The error message.

Returns

ValidationResult

The validation result.

AddError(string, string)

Adds the specified error message to the collection and associates it with the specified key.

public ValidationResult AddError(string key, string error)

Parameters

key string

The key to associate the error with.

error string

The error message.

Returns

ValidationResult

The validation result.

ThrowIfInvalid()

Throws an exception if there were errors during validation.

public ValidationResult ThrowIfInvalid()

Returns

ValidationResult

The validation result.

ToDictionary()

Gets the dictionary of accumulated errors.

public IDictionary<string, string[]> ToDictionary()

Returns

IDictionary<string, string[]>

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.