74 lines
3.8 KiB
C#
74 lines
3.8 KiB
C#
#region License
|
|
// Copyright (c) 2007 James Newton-King
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person
|
|
// obtaining a copy of this software and associated documentation
|
|
// files (the "Software"), to deal in the Software without
|
|
// restriction, including without limitation the rights to use,
|
|
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following
|
|
// conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be
|
|
// included in all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
// OTHER DEALINGS IN THE SOFTWARE.
|
|
#endregion
|
|
|
|
namespace System.Diagnostics.CodeAnalysis
|
|
{
|
|
/// <summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Method | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue, AllowMultiple = true)]
|
|
internal sealed class NotNullAttribute : Attribute { }
|
|
|
|
/// <summary>Specifies that when a method returns <see cref="ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
|
[AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false)]
|
|
internal sealed class NotNullWhenAttribute : Attribute
|
|
{
|
|
/// <summary>Initializes the attribute with the specified return value condition.</summary>
|
|
/// <param name="returnValue">
|
|
/// The return value condition. If the method returns this value, the associated parameter will not be null.
|
|
/// </param>
|
|
public NotNullWhenAttribute(bool returnValue) => ReturnValue = returnValue;
|
|
|
|
/// <summary>Gets the return value condition.</summary>
|
|
public bool ReturnValue { get; }
|
|
}
|
|
|
|
/// <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue, Inherited = false)]
|
|
internal sealed class MaybeNullAttribute : Attribute
|
|
{ }
|
|
|
|
/// <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
|
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property, Inherited = false)]
|
|
internal sealed class AllowNullAttribute : Attribute
|
|
{ }
|
|
|
|
/// <summary>
|
|
/// Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Parameter, Inherited = false)]
|
|
internal class DoesNotReturnIfAttribute : Attribute
|
|
{
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="DoesNotReturnIfAttribute"/> class.
|
|
/// </summary>
|
|
/// <param name="parameterValue">
|
|
/// The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
|
/// the associated parameter matches this value.
|
|
/// </param>
|
|
public DoesNotReturnIfAttribute(bool parameterValue) => this.ParameterValue = parameterValue;
|
|
|
|
/// <summary>Gets the condition parameter value.</summary>
|
|
public bool ParameterValue { get; }
|
|
}
|
|
} |