NAME
App::Base::Script::Option - OO interface for command-line options
SYNOPSIS
my $option = App::Base::Script::Option->new(
{
name => 'foo',
display => '--foo=<f>',
documentation => 'Controls the foo behavior of my script.',
default => 4,
option_type => 'integer',
}
);DESCRIPTION
App::Base::Script::Option is used by App::Base::Script::Common and its descendents to implement the standard definition of command- line options. Typically an object of this class will be constructed anonymously as part of the anonymous arrayref return value of the options() method:
sub options {
return [
App::Base::Script::Option->new(
name => 'foo',
documentation => 'The foo option',
option_type => 'integer',
),
App::Base::Script::Option->new(
name => 'bar',
documentation => 'The bar option',
),
];
}ATTRIBUTES
name
The name of the attribute that must be specified on the command line. This name follows Getopt::Long rules, so its usage can be reduced to the shortest unambiguous specification. In other words, if the options 'fibonacci' and 'fortune' are options to the same script, then --fi and --fo are valid options but -f (or --f) are not because of the ambiguity between the two options.
display
The name as it is displayed in a usage (--help) option (switch) table. By default, it is the same as the name; this method is provided for cases in which it may be helpful to have a usage statement that shows a sample value such as '--max-timeout=<timeout>' rather than simply saying '--max-timeout', because the meaning of --max-timeout is then explained in terms of <timeout> in the documentation for the option.
documentation
A scalar (string) which documents the behavior of the option. REQUIRED.
default
The default value of the option, if any.
option_type
One of: 'integer', 'float', 'string', or 'switch'.
The content of an option field is verified against the provided value during option parsing. For example, --foo=Fred will cause a failure if the 'foo' option was declared to have option_type 'integer'.
METHODS
display_name
Returns the display name of the option, which is either $self->display or (if $self->display is not defined) $self->name. This value is used to generate the switch table documentation.
show_documentation
Returns documentation string for the option