Class ArgumentFlagProvider

Namespace

Webefinity.Switch

Assembly

Switch.dll

A true or false value provider. The true default causes this flag to be set if just the flag is passed, without the true or false value trailing it.

public class ArgumentFlagProvider : IValueProvider

Inheritance

object

ArgumentFlagProvider

Implements

IValueProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ArgumentFlagProvider(bool?)

Construct a flag, passing a default value. If true is not specified after the flag, it will receive its true. In general that default should be false.

public ArgumentFlagProvider(bool? defaultValue)

Parameters

defaultValue bool?

Properties

DefaultValue

The default value if there is one. If a switch is followed only by another switch, the default value will be used by the handler.

public object? DefaultValue { get; }

Property Value

object

Value

The value of the option, stored as a boxed value according to the type the handler should produce.

public object? Value { get; }

Property Value

object

WasSet

Indicates whether the value was set by command line processing. This should be set by the call to the Set method.

public bool WasSet { get; }

Property Value

bool

Methods

Set(string?)

Called by the ArgumentsHandler to set the value of the option in the provider. Should set WasSet to true if the value was used, regardless of its validity.

public ValidationResult Set(string? value)

Parameters

value string

The value of the option as provided on the command line.

Returns

ValidationResult

An validation result, either success, or with errors. If errors are returned the entire command line is considered invalid by the handler.

Usage(Action<string>)

Returns a string for the usage description that describes show to set the value. A true/false flag might return "true, false" here.

public void Usage(Action<string> log)

Parameters

log Action<string>

The action to call when returning the value. This action is expected to be a call to Console.Write.