ValidateNotNullAttribute Class

Validates that the value of an argument is not .

Definition

Namespace: Ookii.CommandLine.Validation
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public class ValidateNotNullAttribute : ArgumentValidationAttribute
Inheritance
Object    Attribute    ArgumentValidationAttribute    ValidateNotNullAttribute

Remarks

An argument's value can only be if its ArgumentConverter returns from the Convert(String, CultureInfo, CommandLineArgument) method. For example, the NullableConverter can return .

It is not necessary to use this attribute on required arguments with types that can't be , such as value types (except NullableT), and if using .Net 6.0 or later, non-nullable reference types. The CommandLineParser already ensures it will not assign to these arguments.

If the argument is optional, validation is only performed if the argument is specified, so the value may still be if the argument is not supplied, if that is the default value.

This validator does not add any help text to the argument description.

Constructors

ValidateNotNullAttributeInitializes a new instance of the ValidateNotNullAttribute class

Properties

ErrorCategory Gets the error category used for the CommandLineArgumentException when validation fails.
(Inherited from ArgumentValidationAttribute)
Mode Gets a value that indicates when validation will run.
(Inherited from ArgumentValidationAttribute)
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)

Methods

EqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetErrorMessage Gets the error message to display if validation failed.
(Overrides ArgumentValidationAttributeGetErrorMessage(CommandLineArgument, Object))
GetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetUsageHelp Gets the usage help message for this validator.
(Inherited from ArgumentValidationAttribute)
IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
IsSpanValid When overridden in a derived class, determines if the argument is valid.
(Inherited from ArgumentValidationAttribute)
IsValid Determines if the argument's value is not .
(Overrides ArgumentValidationAttributeIsValid(CommandLineArgument, Object))
MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validates the argument value, and throws an exception if validation failed.
(Inherited from ArgumentValidationAttribute)
ValidateSpan Validates the argument value, and throws an exception if validation failed.
(Inherited from ArgumentValidationAttribute)

Thread Safety

Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.

See Also