.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "File::Find::Object 3pm"
.TH File::Find::Object 3pm "2014-02-16" "perl v5.18.2" "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"
File::Find::Object \- An object oriented File::Find replacement
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use File::Find::Object;
\&    my $tree = File::Find::Object\->new({}, @targets);
\&
\&    while (my $r = $tree\->next()) {
\&        print $r ."\en";
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
File::Find::Object does the same job as File::Find but works like an object
and with an iterator. As File::Find is not object oriented, one cannot perform
multiple searches in the same application. The second problem of File::Find
is its file processing: after starting its main loop, one cannot easily wait
for another event and so get the next result.
.PP
With File::Find::Object you can get the next file by calling the \fInext()\fR
function, but setting a callback is still possible.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&    my $ffo = File::Find::Object\->new( { options }, @targets);
.Ve
.PP
Create a new File::Find::Object object. \f(CW@targets\fR is the list of
directories or files which the object should explore.
.PP
\fIoptions\fR
.IX Subsection "options"
.IP "depth" 4
.IX Item "depth"
Boolean \- returns the directory content before the directory itself.
.IP "nocrossfs" 4
.IX Item "nocrossfs"
Boolean \- doesn't continue on filesystems different than the parent.
.IP "followlink" 4
.IX Item "followlink"
Boolean \- follow symlinks when they point to a directory.
.Sp
You can safely set this option to true as File::Find::Object does not follow
the link if it detects a loop.
.IP "filter" 4
.IX Item "filter"
Function reference \- should point to a function returning \s-1TRUE\s0 or \s-1FALSE.\s0 This
function is called with the filename to filter, if the function return \s-1FALSE,\s0
the file is skipped.
.IP "callback" 4
.IX Item "callback"
Function reference \- should point to a function, which would be called each
time a new file is returned. The function is called with the current filename
as an argument.
.SS "next"
.IX Subsection "next"
Returns the next file found by the File::Find::Object. It returns undef once
the scan is completed.
.SS "item"
.IX Subsection "item"
Returns the current filename found by the File::Find::Object object, i.e: the
last value returned by \fInext()\fR.
.SS "next_obj"
.IX Subsection "next_obj"
Like \fInext()\fR only returns the result as a convenient
File::Find::Object::Result object. \f(CW\*(C`$ff\->next()\*(C'\fR is equivalent to
\&\f(CW\*(C`$ff\->next_obj()\->path()\*(C'\fR.
.SS "item_obj"
.IX Subsection "item_obj"
Like \fIitem()\fR only returns the result as a convenient
File::Find::Object::Result object. \f(CW\*(C`$ff\->item()\*(C'\fR is equivalent to
\&\f(CW\*(C`$ff\->item_obj()\->path()\*(C'\fR.
.ie n .SS "$ff\->set_traverse_to([@children])"
.el .SS "\f(CW$ff\fP\->set_traverse_to([@children])"
.IX Subsection "$ff->set_traverse_to([@children])"
Sets the children to traverse to from the current node. Useful for pruning
items to traverse.
.ie n .SS "$ff\->\fIprune()\fP"
.el .SS "\f(CW$ff\fP\->\fIprune()\fP"
.IX Subsection "$ff->prune()"
Prunes the current directory. Equivalent to \f(CW$ff\fR\->set_traverse_to([]).
.ie n .SS "[@children] = $ff\->\fIget_traverse_to()\fP"
.el .SS "[@children] = \f(CW$ff\fP\->\fIget_traverse_to()\fP"
.IX Subsection "[@children] = $ff->get_traverse_to()"
Retrieves the children that will be traversed to.
.ie n .SS "[@files] = $ff\->\fIget_current_node_files_list()\fP"
.el .SS "[@files] = \f(CW$ff\fP\->\fIget_current_node_files_list()\fP"
.IX Subsection "[@files] = $ff->get_current_node_files_list()"
Gets all the files that appear in the current directory. This value is
constant for every node, and is useful to use as the basis of the argument
for \f(CW\*(C`set_traverse_to()\*(C'\fR.
.SH "BUGS"
.IX Header "BUGS"
No bugs are known, but it doesn't mean there aren't any.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
There's an article about this module in the Perl Advent Calendar of 2006:
<http://perladvent.pm.org/2006/2/>.
.PP
File::Find is the core module for traversing files in perl, which has
several limitations.
.PP
File::Next, File::Find::Iterator, File::Walker and the unmaintained
File::FTS are alternatives to this module.
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) 2005, 2006 by Olivier Thauvin
.PP
This package is free software; you can redistribute it and/or modify it under
the following terms:
.PP
1. The \s-1GNU\s0 General Public License Version 2.0 \-
http://www.opensource.org/licenses/gpl\-license.php
.PP
2. The Artistic License Version 2.0 \-
http://www.perlfoundation.org/legal/licenses/artistic\-2_0.html
.PP
3. At your option \- any later version of either or both of these licenses.