Debian Codegraph @

upstream/mageia-cauldron/man3pm/TAP::Object.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "TAP::Object 3pm"
61 .TH TAP::Object 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 TAP::Object \- Base class that provides common functionality to all "TAP::*" modules
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 1
74 \& package TAP::Whatever;
75 \&
76 \& use strict;
77 \&
78 \& use base \*(AqTAP::Object\*(Aq;
79 \&
80 \& # new() implementation by TAP::Object
81 \& sub _initialize {
82 \& my ( $self, @args) = @_;
83 \& # initialize your object
84 \& return $self;
85 \& }
86 \&
87 \& # ... later ...
88 \& my $obj = TAP::Whatever\->new(@args);
89 .Ve
90 .SH DESCRIPTION
91 .IX Header "DESCRIPTION"
92 \&\f(CW\*(C`TAP::Object\*(C'\fR provides a default constructor and exception model for all
93 \&\f(CW\*(C`TAP::*\*(C'\fR classes. Exceptions are raised using Carp.
94 .SH METHODS
95 .IX Header "METHODS"
96 .SS "Class Methods"
97 .IX Subsection "Class Methods"
98 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
99 .IX Subsection "new"
100 .PP
101 Create a new object. Any arguments passed to \f(CW\*(C`new\*(C'\fR will be passed on to the
102 "_initialize" method. Returns a new object.
103 .SS "Instance Methods"
104 .IX Subsection "Instance Methods"
105 \fR\f(CI\*(C`_initialize\*(C'\fR\fI\fR
106 .IX Subsection "_initialize"
107 .PP
108 Initializes a new object. This method is a stub by default, you should override
109 it as appropriate.
110 .PP
111 \&\fINote:\fR "new" expects you to return \f(CW$self\fR or raise an exception. See
112 "_croak", and Carp.
113 .PP
114 \fR\f(CI\*(C`_croak\*(C'\fR\fI\fR
115 .IX Subsection "_croak"
116 .PP
117 Raise an exception using \f(CW\*(C`croak\*(C'\fR from Carp, eg:
118 .PP
119 .Vb 1
120 \& $self\->_croak( \*(Aqwhy me?\*(Aq, \*(Aqaaarrgh!\*(Aq );
121 .Ve
122 .PP
123 May also be called as a \fIclass\fR method.
124 .PP
125 .Vb 1
126 \& $class\->_croak( \*(Aqthis works too\*(Aq );
127 .Ve
128 .PP
129 \fR\f(CI\*(C`_confess\*(C'\fR\fI\fR
130 .IX Subsection "_confess"
131 .PP
132 Raise an exception using \f(CW\*(C`confess\*(C'\fR from Carp, eg:
133 .PP
134 .Vb 1
135 \& $self\->_confess( \*(Aqwhy me?\*(Aq, \*(Aqaaarrgh!\*(Aq );
136 .Ve
137 .PP
138 May also be called as a \fIclass\fR method.
139 .PP
140 .Vb 1
141 \& $class\->_confess( \*(Aqthis works too\*(Aq );
142 .Ve
143 .PP
144 \fR\f(CI\*(C`_construct\*(C'\fR\fI\fR
145 .IX Subsection "_construct"
146 .PP
147 Create a new instance of the specified class.
148 .PP
149 \fR\f(CI\*(C`mk_methods\*(C'\fR\fI\fR
150 .IX Subsection "mk_methods"
151 .PP
152 Create simple getter/setters.
153 .PP
154 .Vb 1
155 \& _\|_PACKAGE_\|_\->mk_methods(@method_names);
156 .Ve