Manual Reference Pages  - TAP::Parser::Result (3)

NAME

TAP::Parser::Result - TAP::Parser output

CONTENTS

VERSION

Version 3.10

DESCRIPTION

This is merely a factory class which returns an object representing the current bit of test data from TAP (usually a line). It’s for internal use only and should not be relied upon.

METHODS

new



  my $result = TAP::Parser::Result->new($token);



Returns an instance the appropriate class for the test token passed in.

Boolean methods

The following methods all return a boolean value and are to be overridden in the appropriate subclass.
* is_plan Indicates whether or not this is the test plan line.



 1..3



* is_pragma Indicates whether or not this is a pragma line.



 pragma +strict



* is_test Indicates whether or not this is a test line.



 ok 1 Is OK!



* is_comment Indicates whether or not this is a comment.



 # this is a comment



* is_bailout Indicates whether or not this is bailout line.



 Bail out! We’re out of dilithium crystals.



* is_version Indicates whether or not this is a TAP version line.



 TAP version 4



* is_unknown Indicates whether or not the current line could be parsed.



 ... this line is junk ...



* is_yaml Indicates whether or not this is a YAML chunk.
raw



  print $result->raw;



Returns the original line of text which was parsed.

type



  my $type = $result->type;



Returns the type of a token, such as comment or test.

as_string



  print $result->as_string;



Prints a string representation of the token. This might not be the exact output, however. Tests will have test numbers added if not present, TODO and SKIP directives will be capitalized and, in general, things will be cleaned up. If you need the original text for the token, see the raw method.

is_ok



  if ( $result->is_ok ) { ... }



Reports whether or not a given result has passed. Anything which is not a test result returns true. This is merely provided as a convenient shortcut.

passed

Deprecated. Please use is_ok instead.

has_directive



  if ( $result->has_directive ) {
     ...
  }



Indicates whether or not the given result has a TODO or SKIP directive.

has_todo



 if ( $result->has_todo ) {
     ...
 }



Indicates whether or not the given result has a TODO directive.

has_skip



 if ( $result->has_skip ) {
     ...
 }



Indicates whether or not the given result has a SKIP directive.

set_directive

Set the directive associated with this token. Used internally to fake TODO tests.

Jump to page    or go to Top of page |  Section 3 |  Main Index.


perl v5.8.5 TAP::Parser::Result (3) 2008-02-18
Generated by manServer 1.07 from /usr/share/man/man3/TAP::Parser::Result.3pm using man macros.