1MakeMethods::Docs::CataUlsoegr(3C)ontributed Perl DocumeMnatkaetMieotnhods::Docs::Catalog(3)
2
6 Class::MakeMethods::Docs::Catalog - List of Makable Method Types
7
9 This document lists the various subclasses of Class::MakeMethods
10 included in this distribution, and the method types each one provides.
11 See the documentation for each implementation for more details about
13 the features it provides.
14 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) =head2 Scoping
18 The final part of the name of a method-generating subclass typically
20 indicates the scope or applicability of the methods it generates
21 Hash
23 For object instances based on blessed hashes with named values.
24 Array
26 For object instances based on blessed arrays with positional
27 values.
28 Scalar
30 For object instances based on blessed scalars with a single value.
31 InsideOut
33 For any object instance regardless of underlying data type.
34 Ref For any object instance regardless of underlying data type.
36 Inheritable
38 For data which can be set at the class, subclass, or instance
39 level.
40 Class
42 For class data shared by all instances but different for each
43 subclass
44 ClassVar
46 For class data shared by all instances but different for each
47 subclass
48 ClassInherit
50 For class data shared by all instances but different for each
51 subclass
52 Global
54 For global data shared by a class and all its instances and
55 subclasses
56 PackageVar
58 For global data shared by a class and all its instances and
59 subclasses
60 Universal
62 # General method types that are widely applicable
63 Summary Charts
65 This table shows which scopes are available in each generator family:
66 SCOPING Basic Standard Evaled Composite Template
68 Hash + + + + +
69 Array + + + +
70 Scalar +
71 InsideOut +
72 Ref +
73 Inheritable + + +
74 Class +
75 ClassVar +
76 ClassInherit +
77 Global + + + +
78 PackageVar +
79 Universal + +
80 This table shows which types of methods are typically available in each
82 generator family:
83 METHOD Basic Standard Evaled Composite Template
85 new + + + +
86 scalar + + + +
88 string +
89 string_index +
90 number +
91 boolean +
92 boolean_index +
93 bits +
94 array + + + +
96 struct +
97 hash + + + +
99 hash_of_arrays +
100 tiedhash +
101 object + + +
103 instance +
104 array_of_objects +
105 code +
107 code_or_scalar +
108
110 Basic::Hash (Instances)
111 Methods for objects based on blessed hashes. See
112 Class::MakeMethods::Basic::Hash for details.
113 • new: create and copy instances
115 • scalar: get and set scalar values in each instance
117 • array: get and set values stored in an array refered to in each
119 instance
120 • hash: get and set values in a hash refered to in each instance
122 Basic::Array (Instances)
124 Methods for manipulating positional values in arrays. See
125 Class::MakeMethods::Basic::Array for details.
126 • new: create and copy instances
128 • scalar: get and set scalar values in each instance
130 • array: get and set values stored in an array refered to in each
132 instance
133 • hash: get and set values in a hash refered to in each instance
135 Basic::Global (Global)
137 Global methods are not instance-dependent; calling them by class name
138 or from any instance or subclass will consistently access the same
139 value. See Class::MakeMethods::Basic::Global for details.
140 • scalar: get and set a global scalar value
142 • array: get and set values in a global array
144 • hash: get and set values in a global hash
146
148 Standard::Hash (Instances)
149 Methods for objects based on blessed hashes. See
150 Class::MakeMethods::Standard::Hash for details.
151 • new: create and copy instances
153 • scalar: get and set scalar values in each instance
155 • array: get and set values stored in an array refered to in each
157 instance
158 • hash: get and set values in a hash refered to in each instance
160 • object: access an object refered to by each instance
162 Standard::Array (Instances)
164 Methods for manipulating positional values in arrays. See
165 Class::MakeMethods::Standard::Array for details.
166 • new: create and copy instances
168 • scalar: get and set scalar values in each instance
170 • array: get and set values stored in an array refered to in each
172 instance
173 • hash: get and set values in a hash refered to in each instance
175 • object: access an object refered to by each instance
177 Standard::Global (Global)
179 Methods for manipulating global data. See
180 Class::MakeMethods::Standard::Global for details.
181 • scalar: get and set global scalar
183 • array: get and set values stored in a global array
185 • hash: get and set values in a global hash
187 • object: global access to an object ref
189 Standard::Inheritable (Any)
191 Methods for manipulating data which may be overridden per class or
192 instance. Uses external data storage, so it works with objects of any
193 underlying data type. See Class::MakeMethods::Standard::Inheritable
194 for details.
195 • scalar: get and set scalar values for each instance or class
197
199 Composite::Hash (Instances)
200 Methods for objects based on blessed hashes. See
201 Class::MakeMethods::Composite::Hash for details.
202 • new: create and copy instances
204 • scalar: get and set scalar values in each instance
206 • array: get and set values stored in an array refered to in each
208 instance
209 • hash: get and set values in a hash refered to in each instance
211 • object: access an object refered to by each instance
213 Composite::Array (Instances)
215 Methods for manipulating positional values in arrays. See
216 Class::MakeMethods::Composite::Array for details.
217 • new: create and copy instances
219 • scalar: get and set scalar values in each instance
221 • array: get and set values stored in an array refered to in each
223 instance
224 • hash: get and set values in a hash refered to in each instance
226 • object: access an object refered to by each instance
228 Composite::Global (Global)
230 Methods for manipulating global data. See
231 Class::MakeMethods::Composite::Global for details.
232 • scalar: get and set global scalar
234 • array: get and set values stored in a global array
236 • hash: get and set values in a global hash
238 • object: global access to an object ref
240 Composite::Inheritable (Any)
242 Methods for manipulating data which may be overridden per class or
243 instance. Uses external data storage, so it works with objects of any
244 underlying data type. See Class::MakeMethods::Composite::Inheritable
245 for details.
246 • scalar: get and set scalar values for each instance or class
248 • hook: create a subroutine intended to have operations added to it
250 Composite::Universal (Any)
252 Methods for padding pre- and post-conditions to any class. See
253 Class::MakeMethods::Composite::Universal for details.
254 • patch: add pre and post operations to an existing subroutine
256
258 Template::Universal (Any)
259 Meta-methods for any type of object. See
260 Class::MakeMethods::Template::Universal.
261 • no_op - a method with an empty body
263 • croak - a method which will croak if called
265 • method_init - calls other methods from a list of method name =>
267 argument pairs
268 • forward_methods - delegates to an object provided by another method
270 Template::Ref (Any Instance)
272 Methods for deep copies and comparisons. See
273 Class::MakeMethods::Template::Ref.
274 • clone: make a deep copy of an object instance
276 • prototype: make new objects by cloning a typical instance
278 • compare: compare one object to another
280 Template::Generic (Abstract)
282 The remaining subclasses inherit a similar collection of templates from
283 Template::Generic, and provide a different type of scoping or binding
284 for the functionality defined by the Generic template. See
285 Class::MakeMethods::Template::Generic for details.
286 Template::Hash (Instances)
288 The most commonly used implementation, for objects based on blessed
289 hashes. See Class::MakeMethods::Template::Hash.
290 • new: create and copy instances
292 • scalar: get and set scalar values in each instance
294 • string: get and set string values in each instance
296 • number: get and set numeric values in each instance
298 • boolean: get and set boolean values in each instance
300 • bits: get and set boolean values stored in a single value in each
302 instance
303 • array: get and set values stored in an array refered to in each
305 instance
306 • struct - methods for acccessing values which are stored by position
308 in an array
309 • hash: get and set values in a hash refered to in each instance
311 • tiedhash: get and set values in a tied hash refered to in each
313 instance
314 • hash_of_arrays: for references to hashes of arrays contained in
316 each instance
317 • object: set or access a reference to an object contained in each
319 instance
320 • array_of_objects: manipulate an array of object references within
322 in each instance
323 • code: set or call a function reference contained in each instance
325 Template::Array (Instances)
327 Methods for manipulating positional values in arrays. See
328 Class::MakeMethods::Template::Array.
329 • new: create and copy array instances
331 • scalar: get and set scalar values in a given array position
333 • string: get and set string values in a given array position
335 • number: get and set numeric values in a given array position
337 • boolean: get and set boolean values in a given array position
339 • builtin_isa: generates a wrapper around some builtin function,
341 cacheing the results in the object and providing a by-name
342 interface
343 Template::Scalar (Instances)
345 For objects based on blessed scalars. See
346 Class::MakeMethods::Template::Scalar.
347 Note that these objects can generally only have one value accessor
349 method, as all such accessors will refer to the same value.
350 • new: create and copy instances
352 • scalar: get and set scalar values in each instance
354 • string: get and set a string value in each instance
356 • number: get and set a numeric value in each instance
358 • boolean: get and set a boolean value in each instance
360 • bits: get and set boolean values stored in a single value in each
362 instance
363 • code: set or call a function reference contained in each instance
365 Template::InsideOut (Instances)
367 Stores values for objects in an external location hashed by identity.
368 See Class::MakeMethods::Template::InsideOut.
369 Note that while the below constructor creates and returns scalar
371 references, accessor methods can be created with this implementation
372 for use with any type of object.
373 • new: create and copy instances
375 • scalar: get and set scalar values associated with each instance
377 • string: get and set string values associated with each instance
379 • string_index: get and set string values associated with each
381 instance, and maintain an index of instances by value
382 • number: get and set numeric values associated with each instance
384 • boolean: get and set boolean values associated with each instance
386 • boolean_index: get and set boolean values associated with each
388 instance, and maintain a list of items which have the flag set
389 • bits: get and set boolean values stored in a single value
391 associated with each instance
392 • array: get and set values stored in an array associated with each
394 instance
395 • hash: get and set values in a hash associated with each instance
397 • code: set or call a function reference associated with each
399 instance
400 Template::Global (Global)
402 Global methods are not instance-dependent; calling them by class name
403 or from any instance will consistently access the same value. See
404 Class::MakeMethods::Template::Static.
405 • scalar: get and set a global scalar value
407 • string: get and set a global string value
409 • number: get and set a global number value
411 • boolean: get and set a global boolean value
413 • array: get and set values in a global array
415 • hash: get and set values in a global hash
417 • tiedhash: get and set values in a global tied hash
419 • hash_of_arrays: get and set values in a global hash of arrays
421 • object: set and access a global reference to an object
423 • instance: set and access a global reference to an object of the
425 declaring class
426 • code: set and access a global reference to a subroutine.
428 Template::PackageVar (Global)
430 PackageVar methods access a variable in the declaring package. Thus,
431 they have the same effect as Static methods, while keeping their value
432 accessible via the symbol table. See
433 Class::MakeMethods::Template::PackageVar.
434 • scalar: get and set a global scalar value
436 • string: get and set a global string value
438 • number: get and set a global number value
440 • boolean: get and set a global boolean value
442 • array: get and set values in a global array
444 • hash: get and set values in a global hash
446 Template::Class (Global)
448 Class methods are similar to Static methods, except that each subclass
449 and its instances will access a distinct value. See
450 Class::MakeMethods::Template::Class.
451 • scalar: get and set a class-specific scalar value
453 • string: get and set a class-specific string value
455 • number: get and set a class-specific number value
457 • boolean: get and set a class-specific boolean value
459 • array: get and set values in a class-specific array
461 • hash: get and set values in a class-specific hash
463 Template::ClassVar (Global)
465 ClassVar methods access a variable in the package on which they are
466 called. Thus, they have the same effect as Class methods, while
467 keeping their value accessible via the symbol table, like PackageVar.
468 See Class::MakeMethods::Template::ClassVar.
469 • scalar: get and set a class-specific scalar value
471 • string: get and set a class-specific string value
473 • number: get and set a class-specific number value
475 • boolean: get and set a class-specific boolean value
477 • array: get and set values in a class-specific array
479 • hash: get and set values in a class-specific hash
481 Template::ClassInherit (Global)
483 ClassInherit methods are an intermediate point between Static and Class
484 methods; subclasses inherit their superclass's value until they set
485 their own value, after which they become distinct. See
486 Class::MakeMethods::Template::ClassInherit.
487 • scalar: get and set an inheritable class-specific scalar value
489 • string: get and set an inheritable class-specific string value
491 • number: get and set an inheritable class-specific number value
493 • boolean: get and set an inheritable class-specific boolean value
495 • array: get and set values in an inheritable class-specific array
497 • hash: get and set values in an inheritable class-specific hash
499 Template::Inheritable (Any)
501 Methods for manipulating data which may be overridden per class or
502 instance. Uses external data storage, so it works with objects of any
503 underlying data type. See Class::MakeMethods::Template::Inheritable
504 for details.
505 • scalar: get and set scalar values for each instance or class
507 • string: get and set string values for each instance or class
509 • number: get and set numeric values for each instance or class
511 • boolean: get and set boolean values for each instance or class
513 • hash: get and set values in a hash refered to in each instance
515
517 See Class::MakeMethods for general information about this distribution.
518perl v5.36.0 2023-01-20 MakeMethods::Docs::Catalog(3)