Eiffeldoc: COMMAND_LINE_ARGUMENT

Point of view

All features

expanded class COMMAND_LINE_ARGUMENT_FACTORY

Summary

top

The command-line arguments factory.

Direct parents: Insert list: ANY
Known children: Insert list: COMMAND_LINE_ARGUMENT_CUSTOM_FACTORY

Overview

top

Features

Options

{ANY}

option_string (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[FIXED_STRING]
option_strings (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]
option_file (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[REGULAR_FILE]
option_directory (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[DIRECTORY]
option_integer (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]
option_integers (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[INTEGER_32]]
option_boolean (short: ABSTRACT_STRING, long: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[BOOLEAN]
option_counter (short: ABSTRACT_STRING, long: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]

Positional

{ANY}

positional_string (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[FIXED_STRING]
positional_strings (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]
positional_file (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[REGULAR_FILE]
positional_directory (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[DIRECTORY]
positional_integer (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]
positional_integers (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[INTEGER_32]]

{ANY}

no_parameters: COMMAND_LINE_ARGUMENT

useful to allow an empty command line.
remaining_parameters: COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]

allows parameters to be set after a special "--" option

Option names validity

{ANY}

option_string (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[FIXED_STRING]

effective function

{ANY}

top

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_strings (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]

effective function

{ANY}

top

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_file (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[REGULAR_FILE]

effective function

{ANY}

top

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_directory (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[DIRECTORY]

effective function

{ANY}

top

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_integer (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]

effective function

{ANY}

top

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_integers (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[INTEGER_32]]

effective function

{ANY}

top

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_boolean (short: ABSTRACT_STRING, long: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[BOOLEAN]

effective function

{ANY}

top

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void

option_counter (short: ABSTRACT_STRING, long: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]

effective function

{ANY}

top

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void

positional_string (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[FIXED_STRING]

effective function

{ANY}

top

require

name /= Void

positional_strings (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]

effective function

{ANY}

top

require

name /= Void

positional_file (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[REGULAR_FILE]

effective function

{ANY}

top

require

name /= Void

positional_directory (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[DIRECTORY]

effective function

{ANY}

top

require

name /= Void

positional_integer (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]

effective function

{ANY}

top

require

name /= Void

positional_integers (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[INTEGER_32]]

effective function

{ANY}

top

require

name /= Void

no_parameters: COMMAND_LINE_ARGUMENT

once function

{ANY}

top

useful to allow an empty command line.

remaining_parameters: COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]

once function

{ANY}

top

allows parameters to be set after a special "--" option

short_pattern: REGULAR_EXPRESSION

once function

{ANY}

top

long_pattern: REGULAR_EXPRESSION

once function

{ANY}

top