William Reardon > Iterator-File > Iterator::File::State::Interface

Download:
Iterator-File-1.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 1.5   Source  

NAME ^

Iterator::File::State::Interface -- Interface for Iterator::File state classes

DESCRIPTION ^

All data sources should subclass Iterator::File::State::Interface, overriding methods as appropriate.

Iterator::File::State::Interface inherits from Iterator::File::Utility.

new(%config)

Each subclass can take a %config hash. Keys/meaning will be specific to each subclass.

initialize()

Initilizes any requirements for class. (E.g., prepping temp files.) The iterator is not available until after initialize is invoked.

advance_marker()

Increments the marker by one.

marker()

Return the current value of the marker.

set_marker( $num )

Sets the value of the marker to $num. Note this update is independent of any changes to the source file.

finish()

Perform any required clean up once we're done.

SEE ALSO ^

Iterator::File

AUTHOR ^

William Reardon, <wdr1@pobox.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2008 by William Reardon

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: