NAME

Meta::IO::Dir - extend IO::Dir.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Dir.pm
        PROJECT: meta
        VERSION: 0.00

SYNOPSIS

        package foo;
        use Meta::IO::Dir qw();
        my($object)=Meta::IO::Dir->new("/etc");
        while(!$object->get_over()) {
                my($current)=$object->get_curr();
                # do something with $current
                $object->next();
        }
        $object->close();

DESCRIPTION

This class extends IO::Dir by adding exception handling to the class and a more object oriented style (look at the synopsis).

FUNCTIONS

        new($$)
        next($)
        get_over($)
        get_curr($)
        close($)
        TEST($)

FUNCTION DOCUMENTATION

new($$)

This is a constructor for the Meta::IO::Dir object. It overrides the default IO::Dir constructor and throws an exception if any initialization problems occured (no need to check return value).

next($)

Moves to the next value in the directory.

get_over($)

Returns whether the directory handle is over.

get_curr($)

Returns the current value the directory handle is pointing at.

close($)

Closes the current directory handle.

TEST($)

This is a testing suite for the Meta::IO::Dir module. This test is should be run by a higher level management system at integration or release time or just as a regular routine to check that all is well. This test currently opens a directory in the baseline and prints the entries in it.

SUPER CLASSES

None.

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mailto:veltzer@cpan.org
        WWW: http://www.veltzer.org
        CPAN id: VELTZER

HISTORY

        0.00 MV md5 issues

SEE ALSO

Error(3), IO::Dir(3), Meta::Baseline::Aegis(3), Meta::Utils::Output(3), strict(3)

TODO

Nothing.