CappOption class

CappOption class is a class that represents an option in the console application.

Constructors

CappOption({required String name, String description = '', String value = '', String shortName = ''})

The constructor of the CappOption class. The name is the name of the option. The description is the description of the option. The value is the value of the option. The shortName is the short name of the option.

Properties

description ↔ String

The description of the option it will be shown in the help command. The description should be clear and concise. The description will be shown in the help command.

getter/setter pair

existsInArgs ↔ bool

existsInArgs is a boolean value that represents if the option exists in the arguments or not.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

name ↔ String

The name of the option it will be used to call the option from the console. For example, if the name is 'help' then the option can be called by typing '--help' in the console.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shortName ↔ String

The short name of the option it will be used to call the option from the console. For example, if the short name is 'h' then the option can be called by typing '-h' in the console.

getter/setter pair

value ↔ String

The value of the option it will be used to store the value of the option. The value can be empty or have a value.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited