Curtis "Ovid" Poe > App-Grepl-0.01 > App::Grepl::Results::Token

Download:
App-Grepl-0.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

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

NAME ^

App::Grepl::Results::Token - App::Grepl result by token type.

VERSION ^

Version 0.01

SYNOPSIS ^

OO interface to grepl's individual results.

    use App::Grepl::Results::Token;

    my $found = App::Grepl::Results->new( {
        file     => $file,
    } );
    $found->add_results( $token => \@results );

    print $found->file, "\n";
    while ( my $result = $found->next ) {
        print $result->token, "matched:\n";
        while ( my $item = $result->next ) {
            print "\t$item\n";
        }
    }

METHODS ^

Class Methods

new

    my $grepl = App::Grepl::Results::Token->new( { 
        token   => 'pod',
        results => \@matching_pod,
    } );

Class Methods

token

 my $token = $result->token;
 $result->token($token);

Getter/setter for token type. Will croak if App::Grepl does not recognize the token type.

results

 my $results = $result->results;
 $result->results($results);

Getter/setter for results. Will croak if not passed an array reference.

next

 while ( defined ( my $result = $found->next ) ) {
     ...
 }

Returns the next result found.

Note that the iterator is destructive.

AUTHOR ^

Curtis Poe, <ovid at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-app-grepl at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-Grepl. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc App::Grepl::Results::Token

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2007 Curtis Poe, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: