NAME

Getopt::Yath::Settings - Representation of parsed command line options.

DESCRIPTION

When you parse command line options using Getopt::Yath an instance of this data structure is included in the returnd structure.

SYNOPSIS

my $parsed = parse_options(\@ARGV, ...);

my $settings = $parsed->settings;

my $value = $settings->GROUP->OPTION;

# Or

my $value = $settings->group('GROUP')->option('OPTION');

# Or

my $value = $settings->maybe('GROUP' => 'OPTION', $default);



if ($group = $settings->check_group('GROUP')) {
    # We have the specified group
}

METHODS

$group = $settings->GROUP

If a group exists, there will be a ->GROUP method for it.

$value = $settings->maybe($group_name, $option_name)

$value = $settings->maybe($group_name, $option_name, $default_value)

If the group and option both exist and are defined return the value, otherwise return the default.

$group = $settings->check_group($group_name)

Check if the group exists, if so return it.

$group = $settings->group($group_name)

$group = $settings->group($group_name, $vivify)

Get the specified group. If $vivify is true it will create the group if it does not already exist.

Throws an exception if the group does not exist and vivify is not specified.

$group = $settings->create_group($group_name)

$group = $settings->create_group($group_name, %group_construction_args)

$group = $settings->create_group($group_name, \%group_construction_args)

Create or replace the specified group.

$group = $settings->delete_group($group_name)

Delete the specified group. Also returns a reference to the now deleted group.

SOURCE

The source code repository for Getopt-Yath can be found at http://github.com/Test-More/Getopt-Yath/.

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>

COPYRIGHT

Copyright Chad Granum <exodist7@gmail.com>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://dev.perl.org/licenses/