1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TAP::Object 3perl"
.TH TAP::Object 3perl 2024-05-30 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" 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 "TAP::*" modules
.SH VERSION
.IX Header "VERSION"
Version 3.44
.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"
\fR\f(CI\*(C`new\*(C'\fR\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
"_initialize" method. Returns a new object.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`_initialize\*(C'\fR\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 "new" expects you to return \f(CW$self\fR or raise an exception. See
"_croak", and Carp.
.PP
\fR\f(CI\*(C`_croak\*(C'\fR\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
\fR\f(CI\*(C`_confess\*(C'\fR\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
\fR\f(CI\*(C`_construct\*(C'\fR\fI\fR
.IX Subsection "_construct"
.PP
Create a new instance of the specified class.
.PP
\fR\f(CI\*(C`mk_methods\*(C'\fR\fI\fR
.IX Subsection "mk_methods"
.PP
Create simple getter/setters.
.PP
.Vb 1
\& _\|_PACKAGE_\|_\->mk_methods(@method_names);
.Ve
|
