Kent Fredric > Path-IsDev > Path::IsDev::Role::NegativeHeuristic

Download:
Path-IsDev-1.001001.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.001001   Source  

NAME ^

Path::IsDev::Role::NegativeHeuristic - Base role for Negative Heuristic things.

VERSION ^

version 1.001001

ROLE REQUIRES ^

excludes

Implementing classes must provide this method.

    return : 1 / undef
             1     -> this path is not a development directory as far as this heuristic is concerned
             undef -> this path is a development directory as far as this heuristic is concerned

    args : ( $class , $result_object )
        $class         -> method will be invoked on packages, not objects
        $result_object -> will be a Path::IsDev::Result

Additionally, consuming classes should set $result_object->result( undef ) prior to returning true.

Composing roles should also invoke $result_object->add_reason( $self, $result_value, $descriptive_reason_for_result, \%contextinfo ).

See Path::IsDev::Result for details

METHODS ^

name

Returns the name to use in debugging.

By default, this is derived from the classes name with the PIDNH prefix removed:

    Path::IsDev::NegativeHeuristic::IsDev::IgnoreFile->name()
    → "- ::IsDev::IgnoreFile"

heuristic_type

Returns a description of the general heuristic type

    negative heuristic

AUTHOR ^

Kent Fredric <kentfredric@gmail.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Kent Fredric <kentfredric@gmail.com>.

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

syntax highlighting: