Manual

Reference

Modules

  • A • B • C • D • E
  • F • G • H • I • L
  • M • N • O • P • S
  • T • U • X

Tools

TAP::Object

Perl 5 version 14.0 documentation
Go to top • Download PDF
Show page index • Show recent pages
Recently read

TAP::Object

NAME

TAP::Object - Base class that provides common functionality to all TAP::* modules

VERSION

Version 3.23

SYNOPSIS

  1.     package TAP::Whatever;
  3.     use strict;
  4.     use vars qw(@ISA);
  6.     use TAP::Object;
  8.     @ISA = qw(TAP::Object);
  10.     # new() implementation by TAP::Object
  11.     sub _initialize {
  12.         my ( $self, @args) = @_;
  13.         # initialize your object
  14.         return $self;
  15.     }
  17.     # ... later ...
  18.     my $obj = TAP::Whatever->new(@args);

DESCRIPTION

TAP::Object provides a default constructor and exception model for all TAP::* classes. Exceptions are raised using Carp.

METHODS

Class Methods

new

Create a new object. Any arguments passed to new will be passed on to the _initialize method. Returns a new object.

Instance Methods

_initialize

Initializes a new object. This method is a stub by default, you should override it as appropriate.

Note: new expects you to return $self or raise an exception. See _croak, and Carp.

_croak

Raise an exception using croak from Carp, eg:

  1.     $self->_croak( 'why me?', 'aaarrgh!' );

May also be called as a class method.

  1.     $class->_croak( 'this works too' );

_confess

Raise an exception using confess from Carp, eg:

  1.     $self->_confess( 'why me?', 'aaarrgh!' );

May also be called as a class method.

  1.     $class->_confess( 'this works too' );

_construct

Create a new instance of the specified class.

mk_methods

Create simple getter/setters.

  1.  __PACKAGE__->mk_methods(@method_names);
Page index