Víctor Moral > Iterator-BreakOn > Iterator::BreakOn::Event

Download:
Iterator-BreakOn-0.4.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.1   Source  

NAME ^

Iterator::BreakOn::Event - Build and destroy events

VERSION ^

This documentation refers to Iterator::BreakOn::Event version 0.1

SYNOPSIS ^

    use Iterator::BreakOn::Event;

    my $event = Iterator::BreakOn::Event->new( { 
                    name    => 'before_location',
                    field   =>  'location',
                    value   =>  'AVILA',
                    });

    if ($event->name() eq 'AVILA') {
        # do something ...

    }

DESCRIPTION ^

This module build and destroy event objects for the Iterator::BreakOn package.

SUBROUTINES/METHODS ^

new( )

Create and initialize a new Iterator::BreakOn::Event object. Return a reference to the new object or undef in case of fail.

name( )

Accessor/mutator for the event name. This parameter only can be 'on_first', 'on_last', 'on_every', 'before_*', or 'after_*'; other values raise an exception.

field( )

Accessor/mutator for the field attribute of the object.

value( )

Accessor/mutator for the value attribute of the object.

DIAGNOSTICS ^

invalid event name

DEPENDENCIES ^

Class::Accessor

BUGS AND LIMITATIONS ^

There are no known bugs in this module. Please report problems to the author. Patches are welcome.

AUTHOR ^

Víctor Moral <victor@taquiones.net>

LICENSE AND COPYRIGHT ^

syntax highlighting: