.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Validation::Class::Listing 3pm"
.TH Validation::Class::Listing 3pm "2017-11-24" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Validation::Class::Listing \- Generic Container Class for an Array Reference
.SH "VERSION"
.IX Header "VERSION"
version 7.900057
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Validation::Class::Listing;
\&
\&    my $foos = Validation::Class::Listing\->new;
\&
\&    $foos\->add(\*(Aqfoo\*(Aq);
\&    $foos\->add(\*(Aqbar\*(Aq, \*(Aqbaz\*(Aq);
\&
\&    print $foos\->count; # 3 objects
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Validation::Class::Listing is a container class that provides general-purpose
functionality for arrayref objects.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&    my $self = Validation::Class::Listing\->new;
.Ve
.SS "add"
.IX Subsection "add"
.Vb 1
\&    $self = $self\->add(\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq);
.Ve
.SS "clear"
.IX Subsection "clear"
.Vb 1
\&    $self = $self\->clear;
.Ve
.SS "count"
.IX Subsection "count"
.Vb 1
\&    my $count = $self\->count;
.Ve
.SS "delete"
.IX Subsection "delete"
.Vb 1
\&    $value = $self\->delete($index);
.Ve
.SS "defined"
.IX Subsection "defined"
.Vb 1
\&    $true if $self\->defined($name) # defined
.Ve
.SS "each"
.IX Subsection "each"
.Vb 1
\&    $self = $self\->each(sub{
\&
\&        my ($index, $value) = @_;
\&
\&    });
.Ve
.SS "first"
.IX Subsection "first"
.Vb 1
\&    my $value = $self\->first;
.Ve
.SS "get"
.IX Subsection "get"
.Vb 1
\&    my $value = $self\->get($index); # i.e. $self\->[$index]
.Ve
.SS "grep"
.IX Subsection "grep"
.Vb 1
\&    $new_list = $self\->grep(qr/update_/);
.Ve
.SS "has"
.IX Subsection "has"
.Vb 1
\&    $true if $self\->has($name) # defined
.Ve
.SS "iterator"
.IX Subsection "iterator"
.Vb 1
\&    my $next = $self\->iterator();
\&
\&    # defaults to iterating by keys but accepts sort, rsort, nsort, or rnsort
\&    # e.g. $self\->iterator(\*(Aqsort\*(Aq, sub{ (shift) cmp (shift) });
\&
\&    while (my $item = $next\->()) {
\&        # do something with $item
\&    }
.Ve
.SS "join"
.IX Subsection "join"
.Vb 1
\&    my $string = $self\->join($delimiter);
.Ve
.SS "last"
.IX Subsection "last"
.Vb 1
\&    my $value = $self\->last;
.Ve
.SS "list"
.IX Subsection "list"
.Vb 1
\&    my @list = $self\->list;
.Ve
.SS "nsort"
.IX Subsection "nsort"
.Vb 1
\&    my @list = $self\->nsort;
.Ve
.SS "pairs"
.IX Subsection "pairs"
.Vb 2
\&    my @pairs = $self\->pairs;
\&    # or filter using $self\->pairs(\*(Aqgrep\*(Aq, $regexp);
\&
\&    foreach my $pair (@pairs) {
\&        # $pair\->{index} is $pair\->{value};
\&    }
.Ve
.SS "rnsort"
.IX Subsection "rnsort"
.Vb 1
\&    my @list = $self\->rnsort;
.Ve
.SS "rsort"
.IX Subsection "rsort"
.Vb 1
\&    my @list = $self\->rsort;
.Ve
.SS "sort"
.IX Subsection "sort"
.Vb 1
\&    my @list = $self\->sort(sub{...});
.Ve
.SS "unique"
.IX Subsection "unique"
.Vb 1
\&    my @list = $self\->unique();
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Al Newkirk <anewkirk@ana.io>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Al Newkirk.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.