# PODNAME: CIAO/lib/Param/Match.pm

__END__

=pod

=for :stopwords Diab Jerius Smithsonian Astrophysical Observatory

=head1 NAME

CIAO/lib/Param/Match.pm

=head1 VERSION

version 0.09

=head1 SYNOPSIS

  use CIAO::Lib::Param;

  $pf = CIAO::Lib::Param->new( $filename );
  $pmatch = $pf->match( $template );

  printf "number of matched parameters: %d\n", $pmatch->length;
  while( my $pname = $pmatch->next ) { print "$pname\n" };

  # do it all over again
  $pmatch->rewind;

=head1 DESCRIPTION

These routines manipulate the CIAO::Lib::Param::Match object returned
by the CIAO::Lib::Param B<match()> method.

=head2 Methods

=over

=item length

   $len = $pmatch->length;

returns the number of matched parameters.

=item next

   $pname = $pmatch->next;

returns the name of the next parameter in the list.  It returns
B<undef> if at the end of the list.

=item rewind

   $pmatch->rewind;

Reset the list so that the next call to B<next()> will return the
first element of the list.

=back

=head1 INTERNALS

=head1 NAME

CIAO::Lib::Param::Match - handle a list of matched parameters

=head1 SUPPORT

=head2 Bugs

Please report any bugs or feature requests to bug-ciao-lib-param@rt.cpan.org  or through the web interface at: L<https://rt.cpan.org/Public/Dist/Display.html?Name=CIAO-Lib-Param>

=head2 Source

Source is available at

  https://gitlab.com/djerius/ciao-lib-param

and may be cloned from

  https://gitlab.com/djerius/ciao-lib-param.git

=head1 SEE ALSO

Please see those modules/websites for more information related to this module.

=over 4

=item *

L<CIAO::Lib::Param|CIAO::Lib::Param>

=back

=head1 AUTHOR

Diab Jerius <djerius@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2005 by Smithsonian Astrophysical Observatory.

This is free software, licensed under:

  The GNU General Public License, Version 3, June 2007

=cut
