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)
18
20 Basic::Hash (Instances)
21 Methods for objects based on blessed hashes. See
22 Class::MakeMethods::Basic::Hash for details.
23 • new: create and copy instances
25 • scalar: get and set scalar values in each instance
27 • array: get and set values stored in an array refered to in each
29 instance
30 • hash: get and set values in a hash refered to in each instance
32 Basic::Array (Instances)
34 Methods for manipulating positional values in arrays. See
35 Class::MakeMethods::Basic::Array for details.
36 • new: create and copy instances
38 • scalar: get and set scalar values in each instance
40 • array: get and set values stored in an array refered to in each
42 instance
43 • hash: get and set values in a hash refered to in each instance
45 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 • scalar: get and set a global scalar value
52 • array: get and set values in a global array
54 • hash: get and set values in a global hash
56
58 Standard::Hash (Instances)
59 Methods for objects based on blessed hashes. See
60 Class::MakeMethods::Standard::Hash for details.
61 • new: create and copy instances
63 • scalar: get and set scalar values in each instance
65 • array: get and set values stored in an array refered to in each
67 instance
68 • hash: get and set values in a hash refered to in each instance
70 • object: access an object refered to by each instance
72 Standard::Array (Instances)
74 Methods for manipulating positional values in arrays. See
75 Class::MakeMethods::Standard::Array for details.
76 • new: create and copy instances
78 • scalar: get and set scalar values in each instance
80 • array: get and set values stored in an array refered to in each
82 instance
83 • hash: get and set values in a hash refered to in each instance
85 • object: access an object refered to by each instance
87 Standard::Global (Global)
89 Methods for manipulating global data. See
90 Class::MakeMethods::Standard::Global for details.
91 • scalar: get and set global scalar
93 • array: get and set values stored in a global array
95 • hash: get and set values in a global hash
97 • object: global access to an object ref
99 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 • scalar: get and set scalar values for each instance or class
107
109 Composite::Hash (Instances)
110 Methods for objects based on blessed hashes. See
111 Class::MakeMethods::Composite::Hash for details.
112 • new: create and copy instances
114 • scalar: get and set scalar values in each instance
116 • array: get and set values stored in an array refered to in each
118 instance
119 • hash: get and set values in a hash refered to in each instance
121 • object: access an object refered to by each instance
123 Composite::Array (Instances)
125 Methods for manipulating positional values in arrays. See
126 Class::MakeMethods::Composite::Array for details.
127 • new: create and copy instances
129 • scalar: get and set scalar values in each instance
131 • array: get and set values stored in an array refered to in each
133 instance
134 • hash: get and set values in a hash refered to in each instance
136 • object: access an object refered to by each instance
138 Composite::Global (Global)
140 Methods for manipulating global data. See
141 Class::MakeMethods::Composite::Global for details.
142 • scalar: get and set global scalar
144 • array: get and set values stored in a global array
146 • hash: get and set values in a global hash
148 • object: global access to an object ref
150 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 • scalar: get and set scalar values for each instance or class
158 • hook: create a subroutine intended to have operations added to it
160 Composite::Universal (Any)
162 Methods for padding pre- and post-conditions to any class. See
163 Class::MakeMethods::Composite::Universal for details.
164 • patch: add pre and post operations to an existing subroutine
166
168 Template::Universal (Any)
169 Meta-methods for any type of object. See
170 Class::MakeMethods::Template::Universal.
171 • no_op - a method with an empty body
173 • croak - a method which will croak if called
175 • method_init - calls other methods from a list of method name =>
177 argument pairs
178 • forward_methods - delegates to an object provided by another method
180 Template::Ref (Any Instance)
182 Methods for deep copies and comparisons. See
183 Class::MakeMethods::Template::Ref.
184 • clone: make a deep copy of an object instance
186 • prototype: make new objects by cloning a typical instance
188 • compare: compare one object to another
190 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 Template::Hash (Instances)
198 The most commonly used implementation, for objects based on blessed
199 hashes. See Class::MakeMethods::Template::Hash.
200 • new: create and copy instances
202 • scalar: get and set scalar values in each instance
204 • string: get and set string values in each instance
206 • number: get and set numeric values in each instance
208 • boolean: get and set boolean values in each instance
210 • bits: get and set boolean values stored in a single value in each
212 instance
213 • array: get and set values stored in an array refered to in each
215 instance
216 • struct - methods for acccessing values which are stored by position
218 in an array
219 • hash: get and set values in a hash refered to in each instance
221 • tiedhash: get and set values in a tied hash refered to in each
223 instance
224 • hash_of_arrays: for references to hashes of arrays contained in
226 each instance
227 • object: set or access a reference to an object contained in each
229 instance
230 • array_of_objects: manipulate an array of object references within
232 in each instance
233 • code: set or call a function reference contained in each instance
235 Template::Array (Instances)
237 Methods for manipulating positional values in arrays. See
238 Class::MakeMethods::Template::Array.
239 • new: create and copy array instances
241 • scalar: get and set scalar values in a given array position
243 • string: get and set string values in a given array position
245 • number: get and set numeric values in a given array position
247 • boolean: get and set boolean values in a given array position
249 • builtin_isa: generates a wrapper around some builtin function,
251 cacheing the results in the object and providing a by-name
252 interface
253 Template::Scalar (Instances)
255 For objects based on blessed scalars. See
256 Class::MakeMethods::Template::Scalar.
257 Note that these objects can generally only have one value accessor
259 method, as all such accessors will refer to the same value.
260 • new: create and copy instances
262 • scalar: get and set scalar values in each instance
264 • string: get and set a string value in each instance
266 • number: get and set a numeric value in each instance
268 • boolean: get and set a boolean value in each instance
270 • bits: get and set boolean values stored in a single value in each
272 instance
273 • code: set or call a function reference contained in each instance
275 Template::InsideOut (Instances)
277 Stores values for objects in an external location hashed by identity.
278 See Class::MakeMethods::Template::InsideOut.
279 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 • new: create and copy instances
285 • scalar: get and set scalar values associated with each instance
287 • string: get and set string values associated with each instance
289 • string_index: get and set string values associated with each
291 instance, and maintain an index of instances by value
292 • number: get and set numeric values associated with each instance
294 • boolean: get and set boolean values associated with each instance
296 • boolean_index: get and set boolean values associated with each
298 instance, and maintain a list of items which have the flag set
299 • bits: get and set boolean values stored in a single value
301 associated with each instance
302 • array: get and set values stored in an array associated with each
304 instance
305 • hash: get and set values in a hash associated with each instance
307 • code: set or call a function reference associated with each
309 instance
310 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 • scalar: get and set a global scalar value
317 • string: get and set a global string value
319 • number: get and set a global number value
321 • boolean: get and set a global boolean value
323 • array: get and set values in a global array
325 • hash: get and set values in a global hash
327 • tiedhash: get and set values in a global tied hash
329 • hash_of_arrays: get and set values in a global hash of arrays
331 • object: set and access a global reference to an object
333 • instance: set and access a global reference to an object of the
335 declaring class
336 • code: set and access a global reference to a subroutine.
338 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 • scalar: get and set a global scalar value
346 • string: get and set a global string value
348 • number: get and set a global number value
350 • boolean: get and set a global boolean value
352 • array: get and set values in a global array
354 • hash: get and set values in a global hash
356 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 • scalar: get and set a class-specific scalar value
363 • string: get and set a class-specific string value
365 • number: get and set a class-specific number value
367 • boolean: get and set a class-specific boolean value
369 • array: get and set values in a class-specific array
371 • hash: get and set values in a class-specific hash
373 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 • scalar: get and set a class-specific scalar value
381 • string: get and set a class-specific string value
383 • number: get and set a class-specific number value
385 • boolean: get and set a class-specific boolean value
387 • array: get and set values in a class-specific array
389 • hash: get and set values in a class-specific hash
391 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 • scalar: get and set an inheritable class-specific scalar value
399 • string: get and set an inheritable class-specific string value
401 • number: get and set an inheritable class-specific number value
403 • boolean: get and set an inheritable class-specific boolean value
405 • array: get and set values in an inheritable class-specific array
407 • hash: get and set values in an inheritable class-specific hash
409
411 See Class::MakeMethods for general information about this distribution.
412perl v5.34.0 2022-01-21 MakeMethods::Docs::Catalog(3)