Add new System.ComponentModel.DataAnnotations features #82311
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| namespace System.ComponentModel.DataAnnotations | ||
| { | ||
| /// <summary> | ||
| /// Specifies a list of values that should be allowed in a property. | ||
| /// </summary> | ||
| [CLSCompliant(false)] | ||
| [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, | ||
| AllowMultiple = false)] | ||
| public class AllowedValuesAttribute : ValidationAttribute | ||
| { | ||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="AllowedValuesAttribute"/> class. | ||
| /// </summary> | ||
| /// <param name="values"> | ||
| /// A list of values that the validated value should be equal to. | ||
| /// </param> | ||
| public AllowedValuesAttribute(params object?[] values) | ||
| { | ||
| ArgumentNullException.ThrowIfNull(values); | ||
| Values = values; | ||
| DefaultErrorMessage = SR.AllowedValuesAttribute_Invalid; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the list of values allowed by this attribute. | ||
| /// </summary> | ||
| public object?[] Values { get; } | ||
|
|
||
| /// <summary> | ||
| /// Determines whether a specified object is valid. (Overrides <see cref="ValidationAttribute.IsValid(object)" />) | ||
| /// </summary> | ||
| /// <param name="value">The object to validate.</param> | ||
| /// <returns> | ||
| /// <see langword="true" /> if any of the <see cref="Values"/> are equal to <paramref name="value"/>, | ||
| /// otherwise <see langword="false" /> | ||
| /// </returns> | ||
| /// <remarks> | ||
| /// This method can return <see langword="true"/> if the <paramref name="value" /> is <see langword="null"/>, | ||
| /// provided that <see langword="null"/> is also specified in one of the <see cref="Values"/>. | ||
| /// </remarks> | ||
| public override bool IsValid(object? value) | ||
| { | ||
| foreach (object? allowed in Values) | ||
| { | ||
| if (allowed is null ? value is null : allowed.Equals(value)) | ||
| { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Buffers; | ||
|
|
||
| namespace System.ComponentModel.DataAnnotations | ||
| { | ||
| /// <summary> | ||
| /// Specifies that a data field value is a well-formed Base64 string. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Recognition of valid Base64 is delegated to the <see cref="Convert"/> class, | ||
| /// using the <see cref="Convert.TryFromBase64String(string, Span{byte}, out int)"/> method. | ||
| /// </remarks> | ||
| [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, AllowMultiple = false)] | ||
| public class Base64StringAttribute : ValidationAttribute | ||
| { | ||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="Base64StringAttribute"/> class. | ||
| /// </summary> | ||
| public Base64StringAttribute() | ||
| { | ||
| // Set DefaultErrorMessage not ErrorMessage, allowing user to set | ||
| // ErrorMessageResourceType and ErrorMessageResourceName to use localized messages. | ||
| DefaultErrorMessage = SR.Base64StringAttribute_Invalid; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Determines whether a specified object is valid. (Overrides <see cref="ValidationAttribute.IsValid(object)" />) | ||
| /// </summary> | ||
| /// <param name="value">The object to validate.</param> | ||
| /// <returns> | ||
| /// <see langword="true" /> if <paramref name="value"/> is <see langword="null"/> or is a valid Base64 string, | ||
| /// otherwise <see langword="false" /> | ||
| /// </returns> | ||
| public override bool IsValid(object? value) | ||
| { | ||
| if (value is null) | ||
| { | ||
| return true; | ||
eiriktsarpalis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| if (value is not string valueAsString) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| byte[]? rentedBuffer = null; | ||
| Span<byte> destinationBuffer = valueAsString.Length < 256 | ||
| ? stackalloc byte[256] | ||
| : rentedBuffer = ArrayPool<byte>.Shared.Rent(valueAsString.Length); | ||
|
|
||
| bool result = Convert.TryFromBase64String(valueAsString, destinationBuffer, out int bytesWritten); | ||
|
|
||
| if (rentedBuffer != null) | ||
| { | ||
| destinationBuffer.Slice(0, bytesWritten).Clear(); | ||
| ArrayPool<byte>.Shared.Return(rentedBuffer); | ||
| } | ||
|
|
||
| return result; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| namespace System.ComponentModel.DataAnnotations | ||
| { | ||
| /// <summary> | ||
| /// Specifies a list of values that should not be allowed in a property. | ||
| /// </summary> | ||
| [CLSCompliant(false)] | ||
| [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, | ||
| AllowMultiple = false)] | ||
| public class DeniedValuesAttribute : ValidationAttribute | ||
| { | ||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="DeniedValuesAttribute"/> class. | ||
| /// </summary> | ||
| /// <param name="values"> | ||
| /// A list of values that the validated value should not be equal to. | ||
| /// </param> | ||
| public DeniedValuesAttribute(params object?[] values) | ||
| { | ||
| ArgumentNullException.ThrowIfNull(values); | ||
| Values = values; | ||
| DefaultErrorMessage = SR.DeniedValuesAttribute_Invalid; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the list of values denied by this attribute. | ||
| /// </summary> | ||
| public object?[] Values { get; } | ||
|
|
||
| /// <summary> | ||
| /// Determines whether a specified object is valid. (Overrides <see cref="ValidationAttribute.IsValid(object)" />) | ||
| /// </summary> | ||
| /// <param name="value">The object to validate.</param> | ||
| /// <returns> | ||
| /// <see langword="true" /> if none of the <see cref="Values"/> are equal to <paramref name="value"/>, | ||
| /// otherwise <see langword="false" />. | ||
| /// </returns> | ||
| /// <remarks> | ||
| /// This method can return <see langword="true"/> if the <paramref name="value" /> is <see langword="null"/>, | ||
| /// provided that <see langword="null"/> is not specified in any of the <see cref="Values"/>. | ||
| /// </remarks> | ||
| public override bool IsValid(object? value) | ||
| { | ||
| foreach (object? allowed in Values) | ||
| { | ||
| if (allowed is null ? value is null : allowed.Equals(value)) | ||
| { | ||
|
There was a problem hiding this comment. Nit: Shouldn't the variable name be There was a problem hiding this comment. Ah good point. Would you be interested in contributing a fix? There was a problem hiding this comment. How? I'm newbie here. Don't know the best approach. :) There was a problem hiding this comment. Given that the change is fairly simple, you might be able to send a PR directly from the browser. Open up And hit the edit button:
Make the change and follow the instructions to submit a PR. Done :-) |
||
| return false; | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.