1MakeMethods::Docs::CataUlsoegr(3C)ontributed Perl DocumeMnatkaetMieotnhods::Docs::Catalog(3)
2
3
4

NAME

6       Class::MakeMethods::Docs::Catalog - List of Makable Method Types
7

DESCRIPTION

9       This document lists the various subclasses of Class::MakeMethods
10       included in this distribution, and the method types each one provides.
11
12       See the documentation for each implementation for more details about
13       the features it provides.
14
15       For each class, a parenthetical comment indicates whether the methods
16       it generates are applicable to individual blessed objects (Instances),
17       to class data (Global), or both (Any)
18

BASIC CLASSES

20   Basic::Hash (Instances)
21       Methods for objects based on blessed hashes. See
22       Class::MakeMethods::Basic::Hash for details.
23
24       •   new: create and copy instances
25
26       •   scalar: get and set scalar values in each instance
27
28       •   array: get and set values stored in an array refered to in each
29           instance
30
31       •   hash: get and set values in a hash refered to in each instance
32
33   Basic::Array (Instances)
34       Methods for manipulating positional values in arrays. See
35       Class::MakeMethods::Basic::Array for details.
36
37       •   new: create and copy instances
38
39       •   scalar: get and set scalar values in each instance
40
41       •   array: get and set values stored in an array refered to in each
42           instance
43
44       •   hash: get and set values in a hash refered to in each instance
45
46   Basic::Global (Global)
47       Global methods are not instance-dependent; calling them by class name
48       or from any instance or subclass will consistently access the same
49       value. See Class::MakeMethods::Basic::Global for details.
50
51       •   scalar: get and set a global scalar value
52
53       •   array: get and set values in a global array
54
55       •   hash: get and set values in a global hash
56

STANDARD CLASSES

58   Standard::Hash (Instances)
59       Methods for objects based on blessed hashes. See
60       Class::MakeMethods::Standard::Hash for details.
61
62       •   new: create and copy instances
63
64       •   scalar: get and set scalar values in each instance
65
66       •   array: get and set values stored in an array refered to in each
67           instance
68
69       •   hash: get and set values in a hash refered to in each instance
70
71       •   object: access an object refered to by each instance
72
73   Standard::Array (Instances)
74       Methods for manipulating positional values in arrays. See
75       Class::MakeMethods::Standard::Array for details.
76
77       •   new: create and copy instances
78
79       •   scalar: get and set scalar values in each instance
80
81       •   array: get and set values stored in an array refered to in each
82           instance
83
84       •   hash: get and set values in a hash refered to in each instance
85
86       •   object: access an object refered to by each instance
87
88   Standard::Global (Global)
89       Methods for manipulating global data. See
90       Class::MakeMethods::Standard::Global for details.
91
92       •   scalar: get and set global scalar
93
94       •   array: get and set values stored in a global array
95
96       •   hash: get and set values in a global hash
97
98       •   object: global access to an object ref
99
100   Standard::Inheritable (Any)
101       Methods for manipulating data which may be overridden per class or
102       instance. Uses external data storage, so it works with objects of any
103       underlying data type.  See Class::MakeMethods::Standard::Inheritable
104       for details.
105
106       •   scalar: get and set scalar values for each instance or class
107

COMPOSITE CLASSES

109   Composite::Hash (Instances)
110       Methods for objects based on blessed hashes. See
111       Class::MakeMethods::Composite::Hash for details.
112
113       •   new: create and copy instances
114
115       •   scalar: get and set scalar values in each instance
116
117       •   array: get and set values stored in an array refered to in each
118           instance
119
120       •   hash: get and set values in a hash refered to in each instance
121
122       •   object: access an object refered to by each instance
123
124   Composite::Array (Instances)
125       Methods for manipulating positional values in arrays. See
126       Class::MakeMethods::Composite::Array for details.
127
128       •   new: create and copy instances
129
130       •   scalar: get and set scalar values in each instance
131
132       •   array: get and set values stored in an array refered to in each
133           instance
134
135       •   hash: get and set values in a hash refered to in each instance
136
137       •   object: access an object refered to by each instance
138
139   Composite::Global (Global)
140       Methods for manipulating global data. See
141       Class::MakeMethods::Composite::Global for details.
142
143       •   scalar: get and set global scalar
144
145       •   array: get and set values stored in a global array
146
147       •   hash: get and set values in a global hash
148
149       •   object: global access to an object ref
150
151   Composite::Inheritable (Any)
152       Methods for manipulating data which may be overridden per class or
153       instance. Uses external data storage, so it works with objects of any
154       underlying data type.  See Class::MakeMethods::Composite::Inheritable
155       for details.
156
157       •   scalar: get and set scalar values for each instance or class
158
159       •   hook: create a subroutine intended to have operations added to it
160
161   Composite::Universal (Any)
162       Methods for padding pre- and post-conditions to any class. See
163       Class::MakeMethods::Composite::Universal for details.
164
165       •   patch: add pre and post operations to an existing subroutine
166

TEMPLATE CLASSES

168   Template::Universal (Any)
169       Meta-methods for any type of object. See
170       Class::MakeMethods::Template::Universal.
171
172       •   no_op - a method with an empty body
173
174       •   croak - a method which will croak if called
175
176       •   method_init - calls other methods from a list of method name =>
177           argument pairs
178
179       •   forward_methods - delegates to an object provided by another method
180
181   Template::Ref (Any Instance)
182       Methods for deep copies and comparisons. See
183       Class::MakeMethods::Template::Ref.
184
185       •   clone: make a deep copy of an object instance
186
187       •   prototype: make new objects by cloning a typical instance
188
189       •   compare: compare one object to another
190
191   Template::Generic (Abstract)
192       The remaining subclasses inherit a similar collection of templates from
193       Template::Generic, and provide a different type of scoping or binding
194       for the functionality defined by the Generic template. See
195       Class::MakeMethods::Template::Generic for details.
196
197   Template::Hash (Instances)
198       The most commonly used implementation, for objects based on blessed
199       hashes. See Class::MakeMethods::Template::Hash.
200
201       •   new: create and copy instances
202
203       •   scalar: get and set scalar values in each instance
204
205       •   string: get and set string values in each instance
206
207       •   number: get and set numeric values in each instance
208
209       •   boolean: get and set boolean values in each instance
210
211       •   bits: get and set boolean values stored in a single value in each
212           instance
213
214       •   array: get and set values stored in an array refered to in each
215           instance
216
217       •   struct - methods for acccessing values which are stored by position
218           in an array
219
220       •   hash: get and set values in a hash refered to in each instance
221
222       •   tiedhash: get and set values in a tied hash refered to in each
223           instance
224
225       •   hash_of_arrays: for references to hashes of arrays contained in
226           each instance
227
228       •   object: set or access a reference to an object contained in each
229           instance
230
231       •   array_of_objects: manipulate an array of object references within
232           in each instance
233
234       •   code: set or call a function reference contained in each instance
235
236   Template::Array (Instances)
237       Methods for manipulating positional values in arrays. See
238       Class::MakeMethods::Template::Array.
239
240       •   new: create and copy array instances
241
242       •   scalar: get and set scalar values in a given array position
243
244       •   string: get and set string values in a given array position
245
246       •   number: get and set numeric values in a given array position
247
248       •   boolean: get and set boolean values in a given array position
249
250       •   builtin_isa: generates a wrapper around some builtin function,
251           cacheing the results in the object and providing a by-name
252           interface
253
254   Template::Scalar (Instances)
255       For objects based on blessed scalars.  See
256       Class::MakeMethods::Template::Scalar.
257
258       Note that these objects can generally only have one value accessor
259       method, as all such accessors will refer to the same value.
260
261       •   new: create and copy instances
262
263       •   scalar: get and set scalar values in each instance
264
265       •   string: get and set a string value in each instance
266
267       •   number: get and set a numeric value in each instance
268
269       •   boolean: get and set a boolean value in each instance
270
271       •   bits: get and set boolean values stored in a single value in each
272           instance
273
274       •   code: set or call a function reference contained in each instance
275
276   Template::InsideOut (Instances)
277       Stores values for objects in an external location hashed by identity.
278       See Class::MakeMethods::Template::InsideOut.
279
280       Note that while the below constructor creates and returns scalar
281       references, accessor methods can be created with this implementation
282       for use with any type of object.
283
284       •   new: create and copy instances
285
286       •   scalar: get and set scalar values associated with each instance
287
288       •   string: get and set string values associated with each instance
289
290       •   string_index: get and set string values associated with each
291           instance, and maintain an index of instances by value
292
293       •   number: get and set numeric values associated with each instance
294
295       •   boolean: get and set boolean values associated with each instance
296
297       •   boolean_index: get and set boolean values associated with each
298           instance, and maintain a list of items which have the flag set
299
300       •   bits: get and set boolean values stored in a single value
301           associated with each instance
302
303       •   array: get and set values stored in an array associated with each
304           instance
305
306       •   hash: get and set values in a hash associated with each instance
307
308       •   code: set or call a function reference associated with each
309           instance
310
311   Template::Global (Global)
312       Global methods are not instance-dependent; calling them by class name
313       or from any instance will consistently access the same value.  See
314       Class::MakeMethods::Template::Static.
315
316       •   scalar: get and set a global scalar value
317
318       •   string: get and set a global string value
319
320       •   number: get and set a global number value
321
322       •   boolean: get and set a global boolean value
323
324       •   array: get and set values in a global array
325
326       •   hash: get and set values in a global hash
327
328       •   tiedhash: get and set values in a global tied hash
329
330       •   hash_of_arrays: get and set values in a global hash of arrays
331
332       •   object: set and access a global reference to an object
333
334       •   instance: set and access a global reference to an object of the
335           declaring class
336
337       •   code: set and access a global reference to a subroutine.
338
339   Template::PackageVar (Global)
340       PackageVar methods access a variable in the declaring package. Thus,
341       they have the same effect as Static methods, while keeping their value
342       accessible via the symbol table.  See
343       Class::MakeMethods::Template::PackageVar.
344
345       •   scalar: get and set a global scalar value
346
347       •   string: get and set a global string value
348
349       •   number: get and set a global number value
350
351       •   boolean: get and set a global boolean value
352
353       •   array: get and set values in a global array
354
355       •   hash: get and set values in a global hash
356
357   Template::Class (Global)
358       Class methods are similar to Static methods, except that each subclass
359       and its instances will access a distinct value. See
360       Class::MakeMethods::Template::Class.
361
362       •   scalar: get and set a class-specific scalar value
363
364       •   string: get and set a class-specific string value
365
366       •   number: get and set a class-specific number value
367
368       •   boolean: get and set a class-specific boolean value
369
370       •   array: get and set values in a class-specific array
371
372       •   hash: get and set values in a class-specific hash
373
374   Template::ClassVar (Global)
375       ClassVar methods access a variable in the package on which they are
376       called.  Thus, they have the same effect as Class methods, while
377       keeping their value accessible via the symbol table, like PackageVar.
378       See Class::MakeMethods::Template::ClassVar.
379
380       •   scalar: get and set a class-specific scalar value
381
382       •   string: get and set a class-specific string value
383
384       •   number: get and set a class-specific number value
385
386       •   boolean: get and set a class-specific boolean value
387
388       •   array: get and set values in a class-specific array
389
390       •   hash: get and set values in a class-specific hash
391
392   Template::ClassInherit (Global)
393       ClassInherit methods are an intermediate point between Static and Class
394       methods; subclasses inherit their superclass's value until they set
395       their own value, after which they become distinct. See
396       Class::MakeMethods::Template::ClassInherit.
397
398       •   scalar: get and set an inheritable class-specific scalar value
399
400       •   string: get and set an inheritable class-specific string value
401
402       •   number: get and set an inheritable class-specific number value
403
404       •   boolean: get and set an inheritable class-specific boolean value
405
406       •   array: get and set values in an inheritable class-specific array
407
408       •   hash: get and set values in an inheritable class-specific hash
409

SEE ALSO

411       See Class::MakeMethods for general information about this distribution.
412
413
414
415perl v5.34.0                      2021-07-22     MakeMethods::Docs::Catalog(3)
Impressum