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 val‐
27 ues.
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 sub‐
43 class
44 ClassVar
46 For class data shared by all instances but different for each sub‐
47 class
48 ClassInherit
50 For class data shared by all instances but different for each sub‐
51 class
52 Global
54 For global data shared by a class and all its instances and sub‐
55 classes
56 PackageVar
58 For global data shared by a class and all its instances and sub‐
59 classes
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:
67 SCOPING Basic Standard Evaled Composite Template
69 Hash + + + + +
70 Array + + + +
71 Scalar +
72 InsideOut +
73 Ref +
74 Inheritable + + +
75 Class +
76 ClassVar +
77 ClassInherit +
78 Global + + + +
79 PackageVar +
80 Universal + +
81 This table shows which types of methods are typically available in each
83 generator family:
84 METHOD Basic Standard Evaled Composite Template
86 new + + + +
87 scalar + + + +
89 string +
90 string_index +
91 number +
92 boolean +
93 boolean_index +
94 bits +
95 array + + + +
97 struct +
98 hash + + + +
100 hash_of_arrays +
101 tiedhash +
102 object + + +
104 instance +
105 array_of_objects +
106 code +
108 code_or_scalar +
109
111 Basic::Hash (Instances)
112 Methods for objects based on blessed hashes. See Class::MakeMeth‐
114 ods::Basic::Hash for details.
115 · new: create and copy instances
117 · scalar: get and set scalar values in each instance
119 · array: get and set values stored in an array refered to in each
121 instance
122 · hash: get and set values in a hash refered to in each instance
124 Basic::Array (Instances)
126 Methods for manipulating positional values in arrays. See
128 Class::MakeMethods::Basic::Array for details.
129 · new: create and copy instances
131 · scalar: get and set scalar values in each instance
133 · array: get and set values stored in an array refered to in each
135 instance
136 · hash: get and set values in a hash refered to in each instance
138 Basic::Global (Global)
140 Global methods are not instance-dependent; calling them by class name
142 or from any instance or subclass will consistently access the same
143 value. See Class::MakeMethods::Basic::Global for details.
144 · scalar: get and set a global scalar value
146 · array: get and set values in a global array
148 · hash: get and set values in a global hash
150
152 Standard::Hash (Instances)
153 Methods for objects based on blessed hashes. See Class::MakeMeth‐
155 ods::Standard::Hash for details.
156 · new: create and copy instances
158 · scalar: get and set scalar values in each instance
160 · array: get and set values stored in an array refered to in each
162 instance
163 · hash: get and set values in a hash refered to in each instance
165 · object: access an object refered to by each instance
167 Standard::Array (Instances)
169 Methods for manipulating positional values in arrays. See
171 Class::MakeMethods::Standard::Array for details.
172 · new: create and copy instances
174 · scalar: get and set scalar values in each instance
176 · array: get and set values stored in an array refered to in each
178 instance
179 · hash: get and set values in a hash refered to in each instance
181 · object: access an object refered to by each instance
183 Standard::Global (Global)
185 Methods for manipulating global data. See Class::MakeMethods::Stan‐
187 dard::Global for details.
188 · scalar: get and set global scalar
190 · array: get and set values stored in a global array
192 · hash: get and set values in a global hash
194 · object: global access to an object ref
196 Standard::Inheritable (Any)
198 Methods for manipulating data which may be overridden per class or
200 instance. Uses external data storage, so it works with objects of any
201 underlying data type. See Class::MakeMethods::Standard::Inheritable
202 for details.
203 · scalar: get and set scalar values for each instance or class
205
207 Composite::Hash (Instances)
208 Methods for objects based on blessed hashes. See Class::MakeMeth‐
210 ods::Composite::Hash for details.
211 · new: create and copy instances
213 · scalar: get and set scalar values in each instance
215 · array: get and set values stored in an array refered to in each
217 instance
218 · hash: get and set values in a hash refered to in each instance
220 · object: access an object refered to by each instance
222 Composite::Array (Instances)
224 Methods for manipulating positional values in arrays. See
226 Class::MakeMethods::Composite::Array for details.
227 · new: create and copy instances
229 · scalar: get and set scalar values in each instance
231 · array: get and set values stored in an array refered to in each
233 instance
234 · hash: get and set values in a hash refered to in each instance
236 · object: access an object refered to by each instance
238 Composite::Global (Global)
240 Methods for manipulating global data. See Class::MakeMethods::Compos‐
242 ite::Global for details.
243 · scalar: get and set global scalar
245 · array: get and set values stored in a global array
247 · hash: get and set values in a global hash
249 · object: global access to an object ref
251 Composite::Inheritable (Any)
253 Methods for manipulating data which may be overridden per class or
255 instance. Uses external data storage, so it works with objects of any
256 underlying data type. See Class::MakeMethods::Composite::Inheritable
257 for details.
258 · scalar: get and set scalar values for each instance or class
260 · hook: create a subroutine intended to have operations added to it
262 Composite::Universal (Any)
264 Methods for padding pre- and post-conditions to any class. See
266 Class::MakeMethods::Composite::Universal for details.
267 · patch: add pre and post operations to an existing subroutine
269
271 Template::Universal (Any)
272 Meta-methods for any type of object. See Class::MakeMethods::Tem‐
274 plate::Universal.
275 · no_op - a method with an empty body
277 · croak - a method which will croak if called
279 · method_init - calls other methods from a list of method name =>
281 argument pairs
282 · forward_methods - delegates to an object provided by another method
284 Template::Ref (Any Instance)
286 Methods for deep copies and comparisons. See Class::MakeMethods::Tem‐
288 plate::Ref.
289 · clone: make a deep copy of an object instance
291 · prototype: make new objects by cloning a typical instance
293 · compare: compare one object to another
295 Template::Generic (Abstract)
297 The remaining subclasses inherit a similar collection of templates from
299 Template::Generic, and provide a different type of scoping or binding
300 for the functionality defined by the Generic template. See
301 Class::MakeMethods::Template::Generic for details.
302 Template::Hash (Instances)
304 The most commonly used implementation, for objects based on blessed
306 hashes. See Class::MakeMethods::Template::Hash.
307 · new: create and copy instances
309 · scalar: get and set scalar values in each instance
311 · string: get and set string values in each instance
313 · number: get and set numeric values in each instance
315 · boolean: get and set boolean values in each instance
317 · bits: get and set boolean values stored in a single value in each
319 instance
320 · array: get and set values stored in an array refered to in each
322 instance
323 · struct - methods for acccessing values which are stored by position
325 in an array
326 · hash: get and set values in a hash refered to in each instance
328 · tiedhash: get and set values in a tied hash refered to in each
330 instance
331 · hash_of_arrays: for references to hashes of arrays contained in
333 each instance
334 · object: set or access a reference to an object contained in each
336 instance
337 · array_of_objects: manipulate an array of object references within
339 in each instance
340 · code: set or call a function reference contained in each instance
342 Template::Array (Instances)
344 Methods for manipulating positional values in arrays. See
346 Class::MakeMethods::Template::Array.
347 · new: create and copy array instances
349 · scalar: get and set scalar values in a given array position
351 · string: get and set string values in a given array position
353 · number: get and set numeric values in a given array position
355 · boolean: get and set boolean values in a given array position
357 · builtin_isa: generates a wrapper around some builtin function,
359 cacheing the results in the object and providing a by-name inter‐
360 face
361 Template::Scalar (Instances)
363 For objects based on blessed scalars. See Class::MakeMethods::Tem‐
365 plate::Scalar.
366 Note that these objects can generally only have one value accessor
368 method, as all such accessors will refer to the same value.
369 · new: create and copy instances
371 · scalar: get and set scalar values in each instance
373 · string: get and set a string value in each instance
375 · number: get and set a numeric value in each instance
377 · boolean: get and set a boolean value in each instance
379 · bits: get and set boolean values stored in a single value in each
381 instance
382 · code: set or call a function reference contained in each instance
384 Template::InsideOut (Instances)
386 Stores values for objects in an external location hashed by identity.
388 See Class::MakeMethods::Template::InsideOut.
389 Note that while the below constructor creates and returns scalar refer‐
391 ences, accessor methods can be created with this implementation for use
392 with any type of object.
393 · new: create and copy instances
395 · scalar: get and set scalar values associated with each instance
397 · string: get and set string values associated with each instance
399 · string_index: get and set string values associated with each
401 instance, and maintain an index of instances by value
402 · number: get and set numeric values associated with each instance
404 · boolean: get and set boolean values associated with each instance
406 · boolean_index: get and set boolean values associated with each
408 instance, and maintain a list of items which have the flag set
409 · bits: get and set boolean values stored in a single value associ‐
411 ated with each instance
412 · array: get and set values stored in an array associated with each
414 instance
415 · hash: get and set values in a hash associated with each instance
417 · code: set or call a function reference associated with each
419 instance
420 Template::Global (Global)
422 Global methods are not instance-dependent; calling them by class name
424 or from any instance will consistently access the same value. See
425 Class::MakeMethods::Template::Static.
426 · scalar: get and set a global scalar value
428 · string: get and set a global string value
430 · number: get and set a global number value
432 · boolean: get and set a global boolean value
434 · array: get and set values in a global array
436 · hash: get and set values in a global hash
438 · tiedhash: get and set values in a global tied hash
440 · hash_of_arrays: get and set values in a global hash of arrays
442 · object: set and access a global reference to an object
444 · instance: set and access a global reference to an object of the
446 declaring class
447 · code: set and access a global reference to a subroutine.
449 Template::PackageVar (Global)
451 PackageVar methods access a variable in the declaring package. Thus,
453 they have the same effect as Static methods, while keeping their value
454 accessible via the symbol table. See Class::MakeMethods::Tem‐
455 plate::PackageVar.
456 · scalar: get and set a global scalar value
458 · string: get and set a global string value
460 · number: get and set a global number value
462 · boolean: get and set a global boolean value
464 · array: get and set values in a global array
466 · hash: get and set values in a global hash
468 Template::Class (Global)
470 Class methods are similar to Static methods, except that each subclass
472 and its instances will access a distinct value. See Class::MakeMeth‐
473 ods::Template::Class.
474 · scalar: get and set a class-specific scalar value
476 · string: get and set a class-specific string value
478 · number: get and set a class-specific number value
480 · boolean: get and set a class-specific boolean value
482 · array: get and set values in a class-specific array
484 · hash: get and set values in a class-specific hash
486 Template::ClassVar (Global)
488 ClassVar methods access a variable in the package on which they are
490 called. Thus, they have the same effect as Class methods, while keep‐
491 ing their value accessible via the symbol table, like PackageVar. See
492 Class::MakeMethods::Template::ClassVar.
493 · scalar: get and set a class-specific scalar value
495 · string: get and set a class-specific string value
497 · number: get and set a class-specific number value
499 · boolean: get and set a class-specific boolean value
501 · array: get and set values in a class-specific array
503 · hash: get and set values in a class-specific hash
505 Template::ClassInherit (Global)
507 ClassInherit methods are an intermediate point between Static and Class
509 methods; subclasses inherit their superclass's value until they set
510 their own value, after which they become distinct. See Class::MakeMeth‐
511 ods::Template::ClassInherit.
512 · scalar: get and set an inheritable class-specific scalar value
514 · string: get and set an inheritable class-specific string value
516 · number: get and set an inheritable class-specific number value
518 · boolean: get and set an inheritable class-specific boolean value
520 · array: get and set values in an inheritable class-specific array
522 · hash: get and set values in an inheritable class-specific hash
524 Template::Inheritable (Any)
526 Methods for manipulating data which may be overridden per class or
528 instance. Uses external data storage, so it works with objects of any
529 underlying data type. See Class::MakeMethods::Template::Inheritable
530 for details.
531 · scalar: get and set scalar values for each instance or class
533 · string: get and set string values for each instance or class
535 · number: get and set numeric values for each instance or class
537 · boolean: get and set boolean values for each instance or class
539 · hash: get and set values in a hash refered to in each instance
541
543 See Class::MakeMethods for general information about this distribution.
544perl v5.8.8 2004-09-06 MakeMethods::Docs::Catalog(3)