cpan/Test-Harness/lib/TAP/Parser/Result/Bailout.pm

   1 package TAP::Parser::Result::Bailout;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base 'TAP::Parser::Result';
   7
   8 =head1 NAME
   9
  10 TAP::Parser::Result::Bailout - Bailout result token.
  11
  12 =head1 VERSION
  13
  14 Version 3.43
  15
  16 =cut
  17
  18 our $VERSION = '3.43';
  19
  20 =head1 DESCRIPTION
  21
  22 This is a subclass of L<TAP::Parser::Result>.  A token of this class will be
  23 returned if a bail out line is encountered.
  24
  25  1..5
  26  ok 1 - woo hooo!
  27  Bail out! Well, so much for "woo hooo!"
  28
  29 =head1 OVERRIDDEN METHODS
  30
  31 Mainly listed here to shut up the pitiful screams of the pod coverage tests.
  32 They keep me awake at night.
  33
  34 =over 4
  35
  36 =item * C<as_string>
  37
  38 =back
  39
  40 =cut
  41
  42 ##############################################################################
  43
  44 =head2 Instance Methods
  45
  46 =head3 C<explanation>
  47
  48   if ( $result->is_bailout ) {
  49       my $explanation = $result->explanation;
  50       print "We bailed out because ($explanation)";
  51   }
  52
  53 If, and only if, a token is a bailout token, you can get an "explanation" via
  54 this method.  The explanation is the text after the mystical "Bail out!" words
  55 which appear in the tap output.
  56
  57 =cut
  58
  59 sub explanation { shift->{bailout} }
  60 sub as_string   { shift->{bailout} }
  61
  62 1;