NAME
Iterator::File::Source::Interface -- Interface for Iterator::File data sources
DESCRIPTION
All data sources should subclass Iterator::File::Source::Interface & implement the methods defined here.
Iterator::File::Source::Interface inherits from Iterator::File::Utility.
- new(%config)
-
Construct the object. Argument validation. Default assignment.
- initialize()
-
Any heavy lifting should occur here. E.g., opening a file or shared memory segment.
- next()
-
Advance the iterator & return the new value.
- value()
-
Return the current value, without advancing.
- advance_to( $location )
-
Advance the iterator to $location. If $location is behind the current location, behavior is undefined. (I.e., don't do that.)
- finish()
-
Invoked when all is complete so that cleanup may occur.
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.