Class ArgumentMetadataBase

Namespace

MASES.CLIParser

Assembly

MASES.CLIParser.dll

Class managing the argument information

public class ArgumentMetadataBase : IArgumentMetadata

Inheritance

object

ArgumentMetadataBase

Implements

IArgumentMetadata

Derived

ArgumentMetadata<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ParserExtension.Add(IArgumentMetadata)

ParserExtension.ToString(IArgumentMetadata, params object[])

Properties

ArrayValues

The array of possible values for the argument if ValueType is Array

public virtual object[] ArrayValues { get; set; }

Property Value

object[]

CrossCheck

An Action to cross check multiple values. If something is not correct during check an ArgumentException shall be raised.

public virtual Action<IEnumerable<IArgumentMetadataParsed>> CrossCheck { get; set; }

Property Value

Action<IEnumerable<IArgumentMetadataParsed>>

CustomPrefix

If Prefix contains Custom use CustomPrefix to analyze arguments

public virtual string CustomPrefix { get; set; }

Property Value

string

DataType

The Type of the parameter.

public virtual Type DataType { get; protected set; }

Property Value

Type

Default

The dafault value to use if the value is not found

public virtual object Default { get; set; }

Property Value

object

Help

Argument help

public virtual string Help { get; set; }

Property Value

string

IsCaseInvariant

True if the argument shall be treated as case invariant

public virtual bool? IsCaseInvariant { get; set; }

Property Value

bool?

IsEnum

The argument contains an enumeration value

public virtual bool IsEnum { get; protected set; }

Property Value

bool

IsExtended

True if the argument is an extended argument

public virtual bool IsExtended { get; set; }

Property Value

bool

IsFlag

The argument contains an enumeration value with FlagsAttribute

public virtual bool IsFlag { get; protected set; }

Property Value

bool

IsMandatory

True if the argument shall be mandatory

public virtual bool IsMandatory { get; set; }

Property Value

bool

IsMultiValue

The argument contains multiple values

public virtual bool IsMultiValue { get; set; }

Property Value

bool

KeyValuePairSeparator

Separator used when Type is set to KeyValue

public virtual string KeyValuePairSeparator { get; set; }

Property Value

string

MaxValue

The maximum value for the argument if ValueType is Range

public virtual object MaxValue { get; set; }

Property Value

object

MinValue

The minimum value for the argument if ValueType is Range

public virtual object MinValue { get; set; }

Property Value

object

MultiValueSeparator

The separator used in the multiple value argument

public virtual char? MultiValueSeparator { get; set; }

Property Value

char?

Name

Argument name

public virtual string Name { get; set; }

Property Value

string

Prefix

ArgumentPrefix prefix associated to IArgumentMetadata

public virtual ArgumentPrefix? Prefix { get; set; }

Property Value

ArgumentPrefix?

PrefixInUse

The string representing the actual prefix from configuration

public string PrefixInUse { get; }

Property Value

string

ShortName

Argument short name

public virtual string ShortName { get; set; }

Property Value

string

Type

Set how to manage the IArgumentMetadata

public virtual ArgumentType? Type { get; set; }

Property Value

ArgumentType?

ValueType

ArgumentValueType to check input

public virtual ArgumentValueType? ValueType { get; set; }

Property Value

ArgumentValueType?

Methods

DefaultFileArgumentMetadata(Parser)

Dafault used to check for file argument

public static IArgumentMetadata DefaultFileArgumentMetadata(Parser parser)

Parameters

parser Parser

Returns

IArgumentMetadata