AbstractSpec<T> Class

Namespace:: Maroontress.Cui.Impl

Assembly:: CuiMallet.dll

The abstraction of OptionSpec and subclasses.

public abstract class AbstractSpec<T> : Spec
    where T : Option

Type Parameters

T: Option

The type of Option interface.

Inheritance: object
AbstractSpec<T>

Implements: Spec

Constructors

AbstractSpec(string, char?, string, Action<T>)

Initializes a new instance of the AbstractSpec<T> class.

Properties

Name
ShortName
Description

Methods

Fire(T)	Invokes the callback function.
VisitLongOption(ParseKit, Builder, string, Queue<string>)	Description copied from interface: Spec Visits the long option.
VisitShortOption(ParseKit, Builder, Queue<char>, Queue<string>)	Description copied from interface: Spec Visits the short option.
GetHelpHeading()	Description copied from interface: Spec Gets the heading of the help message.
Equals(object)	(Inherited from object)
GetHashCode()	(Inherited from object)
GetType()	(Inherited from object)
MemberwiseClone()	(Inherited from object)
ToString()	(Inherited from object)

Constructors Detail

AbstractSpec(string, char?, string, Action<T>)

Initializes a new instance of the AbstractSpec<T> class.

public AbstractSpec(string name, char? shortName, string description, Action<T> action)

Parameters

name: string

The name of the option.

shortName: char?

The short name of the option, if any.

description: string

The description of the option.

action: Action<T>

The action to be invoked.

Properties Detail

Name

public string Name { get; }

Property Value

string

Implements

Spec.Name

ShortName

public char? ShortName { get; }

Property Value

char?

Implements

Spec.ShortName

Description

public string Description { get; }

Property Value

string

Implements

Spec.Description

Methods Detail

Fire(T)

Invokes the callback function.

public void Fire(T option)

Parameters

option: T

The option to be consumed.

VisitLongOption(ParseKit, Builder, string, Queue<string>)

Description copied from interface: Spec

Visits the long option.

public abstract void VisitLongOption(ParseKit kit, Builder builer, string argument, Queue<string> queue)

Parameters

kit: ParseKit

builer: Builder

argument: string

queue: Queue<string>

Implements

Spec.VisitLongOption(ParseKit, Builder, string, Queue<string>)

VisitShortOption(ParseKit, Builder, Queue<char>, Queue<string>)

Description copied from interface: Spec

Visits the short option.

public abstract void VisitShortOption(ParseKit kit, Builder builder, Queue<char> shortNameQueue, Queue<string> queue)

Parameters

kit: ParseKit

builder: Builder

shortNameQueue: Queue<char>

queue: Queue<string>

Implements

Spec.VisitShortOption(ParseKit, Builder, Queue<char>, Queue<string>)

GetHelpHeading()

Description copied from interface: Spec

Gets the heading of the help message.

public abstract string GetHelpHeading()

Returns

string

Description copied from interface: Spec

The heading of the help message.

Implements

Spec.GetHelpHeading()