Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

TAP::Object (3)

Name

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

Synopsis

package TAP::Whatever;

use strict;

use base 'TAP::Object';

# new() implementation by TAP::Object
sub _initialize {
my ( $self, @args) = @_;
# initialize your object
return $self;
}

# ... later ...
my $obj = TAP::Whatever->new(@args);

Description

Perl Programmers Reference Guide                                TAP::Object(3)



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

VERSION
       Version 3.42

SYNOPSIS
           package TAP::Whatever;

           use strict;

           use base 'TAP::Object';

           # new() implementation by TAP::Object
           sub _initialize {
               my ( $self, @args) = @_;
               # initialize your object
               return $self;
           }

           # ... later ...
           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:

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

       May also be called as a class method.

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

       "_confess"

       Raise an exception using "confess" from Carp, eg:

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

       May also be called as a class method.

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

       "_construct"

       Create a new instance of the specified class.

       "mk_methods"

       Create simple getter/setters.

        __PACKAGE__->mk_methods(@method_names);



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14                    TAP::Object(3)