AnonymousFox

//usr/local/ssl/share/man/man3/TAP::Object.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "TAP::Object 3"
.TH TAP::Object 3 "2018-03-19" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
TAP::Object \- Base class that provides common functionality to all \f(CW\*(C`TAP::*\*(C'\fR modules
.SH "VERSION"
.IX Header "VERSION"
Version 3.42
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package TAP::Whatever;
\&
\&    use strict;
\&
\&    use base \*(AqTAP::Object\*(Aq;
\&
\&    # new() implementation by TAP::Object
\&    sub _initialize {
\&        my ( $self, @args) = @_;
\&        # initialize your object
\&        return $self;
\&    }
\&
\&    # ... later ...
\&    my $obj = TAP::Whatever\->new(@args);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`TAP::Object\*(C'\fR provides a default constructor and exception model for all
\&\f(CW\*(C`TAP::*\*(C'\fR classes.  Exceptions are raised using Carp.
.SH "METHODS"
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fI\f(CI\*(C`new\*(C'\fI\fR
.IX Subsection "new"
.PP
Create a new object.  Any arguments passed to \f(CW\*(C`new\*(C'\fR will be passed on to the
\&\*(L"_initialize\*(R" method.  Returns a new object.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fI\f(CI\*(C`_initialize\*(C'\fI\fR
.IX Subsection "_initialize"
.PP
Initializes a new object.  This method is a stub by default, you should override
it as appropriate.
.PP
\&\fINote:\fR \*(L"new\*(R" expects you to return \f(CW$self\fR or raise an exception.  See
\&\*(L"_croak\*(R", and Carp.
.PP
\fI\f(CI\*(C`_croak\*(C'\fI\fR
.IX Subsection "_croak"
.PP
Raise an exception using \f(CW\*(C`croak\*(C'\fR from Carp, eg:
.PP
.Vb 1
\&    $self\->_croak( \*(Aqwhy me?\*(Aq, \*(Aqaaarrgh!\*(Aq );
.Ve
.PP
May also be called as a \fIclass\fR method.
.PP
.Vb 1
\&    $class\->_croak( \*(Aqthis works too\*(Aq );
.Ve
.PP
\fI\f(CI\*(C`_confess\*(C'\fI\fR
.IX Subsection "_confess"
.PP
Raise an exception using \f(CW\*(C`confess\*(C'\fR from Carp, eg:
.PP
.Vb 1
\&    $self\->_confess( \*(Aqwhy me?\*(Aq, \*(Aqaaarrgh!\*(Aq );
.Ve
.PP
May also be called as a \fIclass\fR method.
.PP
.Vb 1
\&    $class\->_confess( \*(Aqthis works too\*(Aq );
.Ve
.PP
\fI\f(CI\*(C`_construct\*(C'\fI\fR
.IX Subsection "_construct"
.PP
Create a new instance of the specified class.
.PP
\fI\f(CI\*(C`mk_methods\*(C'\fI\fR
.IX Subsection "mk_methods"
.PP
Create simple getter/setters.
.PP
.Vb 1
\& _\|_PACKAGE_\|_\->mk_methods(@method_names);
.Ve