File Coverage

blib/lib/TAP/Parser/SourceHandler.pm

Criterion	Covered	Total	%
statement	16	18	88.8
branch			n/a
condition			n/a
subroutine	6	6	100.0
pod	2	2	100.0
total	24	26	92.3

package TAP::Parser::SourceHandler;

use strict;
use warnings;

use TAP::Parser::Iterator ();
use base 'TAP::Object';

=head1 NAME

TAP::Parser::SourceHandler - Base class for different TAP source handlers

=head1 VERSION

Version 3.40_01

=cut

our $VERSION = '3.40_01';

=head1 SYNOPSIS

  # abstract class - don't use directly!
  # see TAP::Parser::IteratorFactory for general usage

  # must be sub-classed for use
  package MySourceHandler;
  use base 'TAP::Parser::SourceHandler';
  sub can_handle    { return $confidence_level }
  sub make_iterator { return $iterator }

  # see example below for more details

=head1 DESCRIPTION

This is an abstract base class for L handlers / handlers.

A C does whatever is necessary to produce & capture
a stream of TAP from the I source, and package it up in a
L for the parser to consume.

C must implement the I interface
used by L.  At 2 methods, the interface is pretty
simple: L and L.

Unless you're writing a new L, a plugin, or
subclassing L, you probably won't need to use this module directly.

=head1 METHODS

=head2 Class Methods

=head3 C

I.

  my $vote = $class->can_handle( $source );

C<$source> is a L.

Returns a number between C<0> & C<1> reflecting how confidently the raw source
can be handled.  For example, C<0> means the source cannot handle it, C<0.5>
means it may be able to, and C<1> means it definitely can.  See
L for details on how this is used.

=cut

sub can_handle {
    my ( $class, $args ) = @_;
    $class->_croak(
        "Abstract method 'can_handle' not implemented for $class!");
    return;
}

=head3 C

I.

  my $iterator = $class->make_iterator( $source );

C<$source> is a L.

Returns a new L object for use by the L.
Cs on error.

=cut

sub make_iterator {
    my ( $class, $args ) = @_;
    $class->_croak(
        "Abstract method 'make_iterator' not implemented for $class!");
    return;
}
1;

__END__