File: //usr/share/man/man3/TAP::Parser::IteratorFactory.3pm
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "TAP::Parser::IteratorFactory 3"
.TH TAP::Parser::IteratorFactory 3 "2009-05-05" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
TAP::Parser::IteratorFactory \- Internal TAP::Parser Iterator
.SH "VERSION"
.IX Header "VERSION"
Version 3.17
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\& use TAP::Parser::IteratorFactory;
\& my $factory = TAP::Parser::IteratorFactory->new;
\& my $iter = $factory->make_iterator(\e*TEST);
\& my $iter = $factory->make_iterator(\e@array);
\& my $iter = $factory->make_iterator(\e%hash);
.Ve
.PP
.Vb 1
\& my $line = $iter->next;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a factory class for simple iterator wrappers for arrays, filehandles,
and hashes. Unless you're subclassing, you probably won't need to use this
module directly.
.SH "METHODS"
.IX Header "METHODS"
.Sh "Class Methods"
.IX Subsection "Class Methods"
\fI\f(CI\*(C`new\*(C'\fI\fR
.IX Subsection "new"
.PP
Creates a new factory class.
\&\fINote:\fR You currently don't need to instantiate a factory in order to use it.
.PP
\fI\f(CI\*(C`make_iterator\*(C'\fI\fR
.IX Subsection "make_iterator"
.PP
Create an iterator. The type of iterator created depends on the arguments to
the constructor:
.PP
.Vb 1
\& my $iter = TAP::Parser::Iterator->make_iterator( $filehandle );
.Ve
.PP
Creates a \fIstream\fR iterator (see \*(L"make_stream_iterator\*(R").
.PP
.Vb 1
\& my $iter = TAP::Parser::Iterator->make_iterator( $array_reference );
.Ve
.PP
Creates an \fIarray\fR iterator (see \*(L"make_array_iterator\*(R").
.PP
.Vb 1
\& my $iter = TAP::Parser::Iterator->make_iterator( $hash_reference );
.Ve
.PP
Creates a \fIprocess\fR iterator (see \*(L"make_process_iterator\*(R").
.PP
\fI\f(CI\*(C`make_stream_iterator\*(C'\fI\fR
.IX Subsection "make_stream_iterator"
.PP
Make a new stream iterator and return it. Passes through any arguments given.
Defaults to a TAP::Parser::Iterator::Stream.
.PP
\fI\f(CI\*(C`make_array_iterator\*(C'\fI\fR
.IX Subsection "make_array_iterator"
.PP
Make a new array iterator and return it. Passes through any arguments given.
Defaults to a TAP::Parser::Iterator::Array.
.PP
\fI\f(CI\*(C`make_process_iterator\*(C'\fI\fR
.IX Subsection "make_process_iterator"
.PP
Make a new process iterator and return it. Passes through any arguments given.
Defaults to a TAP::Parser::Iterator::Process.
.SH "SUBCLASSING"
.IX Header "SUBCLASSING"
Please see \*(L"\s-1SUBCLASSING\s0\*(R" in TAP::Parser for a subclassing overview.
.PP
There are a few things to bear in mind when creating your own
\&\f(CW\*(C`ResultFactory\*(C'\fR:
.IP "1" 4
.IX Item "1"
The factory itself is never instantiated (this \fImay\fR change in the future).
This means that \f(CW\*(C`_initialize\*(C'\fR is never called.
.Sh "Example"
.IX Subsection "Example"
.Vb 1
\& package MyIteratorFactory;
.Ve
.PP
.Vb 2
\& use strict;
\& use vars '@ISA';
.Ve
.PP
.Vb 2
\& use MyStreamIterator;
\& use TAP::Parser::IteratorFactory;
.Ve
.PP
.Vb 1
\& @ISA = qw( TAP::Parser::IteratorFactory );
.Ve
.PP
.Vb 5
\& # override stream iterator
\& sub make_stream_iterator {
\& my $proto = shift;
\& MyStreamIterator->new(@_);
\& }
.Ve
.PP
.Vb 1
\& 1;
.Ve
.SH "ATTRIBUTION"
.IX Header "ATTRIBUTION"
Originally ripped off from Test::Harness.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
TAP::Object,
TAP::Parser,
TAP::Parser::Iterator,
TAP::Parser::Iterator::Array,
TAP::Parser::Iterator::Stream,
TAP::Parser::Iterator::Process,