1MakeMethods::Template::UGseenrerCiocn(t3r)ibuted Perl DoMcaukmeeMnettahtoidosn::Template::Generic(3)
2
6 Class::MakeMethods::Template::Generic - Templates for common
7 meta-method types
8
10 package MyObject;
11 use Class::MakeMethods (
12 'Template::Hash:new' => [ 'new' ],
13 'Template::Hash:scalar' => [ 'foo' ]
14 'Template::Static:scalar' => [ 'bar' ]
15 );
16 package main;
18 my $obj = MyObject->new( foo => "Foozle", bar => "Bozzle" );
20 print $obj->foo();
21 $obj->bar("Bamboozle");
22
24 This package provides a variety of abstract interfaces for constructors
25 and accessor methods, which form a common foundation for meta-methods
26 provided by the Hash, Scalar, Flyweight, Static, PackageVar, and Class‐
27 Var implementations.
28 Generally speaking, the Generic meta-methods define calling interfaces
30 and behaviors which are bound to differently scoped data by each of
31 those subclasses.
32 new Constructor
34 There are several types of hash-based object constructors to choose
36 from.
37 Each of these methods creates and returns a reference to a new blessed
39 instance. They differ in how their (optional) arguments are interpreted
40 to set initial values, and in how they operate when called as class or
41 instance methods.
42 Interfaces: The following interfaces are supported.
44 -with_values,
46 Provides the with_values behavior.
47 -with_init
49 Provides the with_init behavior.
50 -with_methods
52 Provides the with_methods behavior.
53 -new_and_init
55 Provides the with_init behavior for *, and the general purpose
56 method_init behavior as an init method.
57 -copy_with_values
59 Provides the copy behavior.
60 Behaviors: The following types of constructor methods are available.
62 with_values
64 Creates and blesses a new instance.
65 If arguments are passed they are included in the instance, other‐
67 wise it will be empty.
68 Returns the new instance.
70 May be called as a class or instance method.
72 with_methods
74 Creates, blesses, and returns a new instance.
75 The arguments are treated as a hash of method-name/argument-value
77 pairs, with each such pair causing a call "$self->name($value)".
78 with_init
80 Creates and blesses a new instance, then calls a method named
81 "init", passing along any arguments that were initially given.
82 Returns the new instance.
84 The init() method should be defined in the class declaring these
86 methods.
87 May be called as a class or instance method.
89 and_then_init
91 Creates a new instance using method-name/argument-value pairs, like
92 "with_methods", but then calls a method named "init" before return‐
93 ing the new object. The "init" method does not receive any argu‐
94 ments.
95 The init() method should be defined in the class declaring these
97 methods.
98 instance_with_methods
100 If called as a class method, creates, blesses, and returns a new
101 instance. If called as an object method, operates on and returns
102 the existing instance.
103 Accepts name-value pair arguments, or a reference to hash of such
105 pairs, and calls the named method for each with the supplied value
106 as a single argument. (See the Universal method_init behavior for
107 more discussion of this pattern.)
108 copy_with values
110 Produce a copy of an instance. Can not be called as a class method.
111 The copy is a *shallow* copy; any references will be shared by the
113 instance upon which the method is called and the returned newborn.
114 If a list of key-value pairs is passed as arguments to the method,
116 they are added to the copy, overwriting any values with the same
117 key that may have been copied from the original.
118 copy_with_methods
120 Produce a copy of an instance. Can not be called as a class method.
121 The copy is a *shallow* copy; any references will be shared by the
123 instance upon which the method is called and the returned newborn.
124 Accepts name-value pair arguments, or a reference to hash of such
126 pairs, and calls the named method on the copy for each with the
127 supplied value as a single argument before the copy is returned.
128 copy_instance_with_values
130 If called as a class method, creates, blesses, and returns a new
131 instance. If called as an object method, produces and returns a
132 copy of an instance.
133 The copy is a *shallow* copy; any references will be shared by the
135 instance upon which the method is called and the returned newborn.
136 If a list of key-value pairs is passed as arguments to the method,
138 they are added to the copy, overwriting any values with the same
139 key that may have been copied from the original.
140 copy_instance_with_methods
142 If called as a class method, creates, blesses, and returns a new
143 instance. If called as an object method, produces and returns a
144 copy of an instance.
145 The copy is a *shallow* copy; any references will be shared by the
147 instance upon which the method is called and the returned newborn.
148 Accepts name-value pair arguments, or a reference to hash of such
150 pairs, and calls the named method on the copy for each with the
151 supplied value as a single argument before the copy is returned.
152 Parameters: The following parameters are supported:
154 init_method
156 The name of the method to call after creating a new instance.
157 Defaults to 'init'.
158 scalar Accessor
160 A generic scalar-value accessor meta-method which serves as an abstrac‐
162 tion for basic "get_set" methods and numerous related interfaces
163 use Class::MakeMethods -MakerClass => "...",
165 scalar => [ 'foo', 'bar' ];
166 ...
167 $self->foo( 'my new foo value' );
168 print $self->foo();
169 (Note that while you can use the scalar methods to store references to
171 various data structures, there are other meta-methods defined below
172 that may be more useful for managing references to arrays, hashes, and
173 objects.)
174 Interfaces: The following calling interfaces are available.
176 get_set (default)
178 Provides get_set method for *.
179 Example: Create method foo, which sets the value of 'foo' for this
181 instance if an argument is passed in, and then returns the value
182 whether or not it's been changed:
183 use Class::MakeMethods -MakerClass => "...",
185 scalar => [ 'foo' ];
186 get_protected_set
188 Provides an get_set accessor for * that croaks if a new value is
189 passed in from a package that is not a subclass of the declaring
190 one.
191 get_private_set
193 Provides an get_set accessor for * that croaks if a new value is
194 passed in from a package other than the declaring one.
195 read_only
197 Provides an accessor for * that does not modify its value. (Its
198 initial value would have to be set by some other means.)
199 eiffel
201 Provides get behavior as *, and set behavior as set_*.
202 Example: Create methods bar which returns the value of 'bar' for
204 this instance (takes no arguments), and set_bar, which sets the
205 value of 'bar' (no return):
206 use Class::MakeMethods -MakerClass => "...",
208 scalar => [ --eiffel => 'bar' ];
209 java
211 Provides get behavior as get*, and set behavior as set*.
212 Example: Create methods getBaz which returns the value of 'Baz' for
214 this instance (takes no arguments), and setBaz, which sets the
215 value for this instance (no return):
216 use Class::MakeMethods -MakerClass => "...",
218 scalar => [ --java => 'Baz' ];
219 init_and_get
221 Creates methods which cache their results in a hash key.
222 Provides the get_init behavior for *, and an delete behavior for
224 clear_*. Specifies default value for init_method parameter of
225 init_*.
226 with_clear
228 Provides get_set behavior for *, and a clear_* method.
229 Behaviors: The following types of accessor methods are available.
231 get_set
233 If no argument is provided, returns the value of the current
234 instance. The value defaults to undef.
235 If an argument is provided, it is stored as the value of the cur‐
237 rent instance (even if the argument is undef), and that value is
238 returned.
239 Also available as get_protected_set and get_private_set, which are
241 available for public read-only access, but have access control lim‐
242 itations.
243 get Returns the value from the current instance.
245 set Sets the value for the current instance. If called with no argu‐
247 ments, the value is set to undef. Does not return a value.
248 clear
250 Sets value to undef.
251 get_set_chain
253 Like get_set, but if called with an argument, returns the object it
254 was called on. This allows a series of mutators to be called as
255 follows:
256 package MyObject;
258 use Class::MakeMethods (
259 'Template::Hash:scalar --get_set_chain' => 'foo bar baz'
260 );
261 ...
262 my $obj = MyObject->new->foo('Foozle');
264 $obj->bar("none")->baz("Brazil");
265 print $obj->foo, $obj->bar, $obj->baz;
266 get_set_prev
268 Like get_set, but if called with an argument, returns the previous
269 value before it was changed to the new one.
270 get_init
272 If the value is currently undefined, calls the init_method. Returns
273 the value.
274 Parameters: The following parameters are supported:
276 init_method
278 The name of a method to be called to initialize this meta-method.
279 Only used by the get_init behavior.
281 string Accessor
283 A generic scalar-value accessor meta-method which serves as an abstrac‐
285 tion for basic "get_set" methods and numerous related interfaces
286 use Class::MakeMethods -MakerClass => "...",
288 string => [ 'foo', 'bar' ];
289 ...
290 $self->foo( 'my new foo value' );
291 print $self->foo();
292 This meta-method extends the scalar meta-method, and supports the same
294 interfaces and parameters.
295 However, it generally treats values as strings, and can not be used to
297 store references.
298 Interfaces: In addition to those provided by "scalar", the following
300 calling interfaces are available.
301 -get_concat
303 Provides the get_concat behavior for *, and a clear_* method.
304 Example:
306 use Class::MakeMethods
308 get_concat => { name => 'words', join => ", " };
309 $obj->words('foo');
311 $obj->words('bar');
312 $obj->words() eq 'foo, bar';
313 Behaviors: In addition to those provided by "scalar", the following
315 types of accessor methods are available.
316 concat
318 Concatenates the argument value with the existing value.
319 get_concat
321 Like get_set except sets do not clear out the original value, but
322 instead concatenate the new value to the existing one.
323 Parameters: In addition to those provided by "scalar", the following
325 parameters are supported.
326 join
328 If the join parameter is defined, each time the get_concat behavior
329 is invoked, it will glue its argument onto any existing value with
330 the join string as the separator. The join field is applied between
331 values, not prior to the first or after the last. Defaults to unde‐
332 fined
333 string_index
335 string_index => [ qw / foo bar baz / ]
337 Creates string accessor methods, like string above, but also maintains
339 a static hash index in which each object is stored under the value of
340 the field when the slot is set.
341 This is a unique index, so only one object can have a given key. If an
343 object has a slot set to a value which another object is already set to
344 the object currently set to that value has that slot set to undef and
345 the new object will be put into the hash under that value.
346 Objects with undefined values are not stored in the index.
348 Note that to free items from memory, you must clear these values!
350 Methods:
352 · The method find_x is defined which if called with any arguments
354 returns a list of the objects stored under those values in the
355 hash. Called with no arguments, it returns a reference to the hash.
356 Profiles:
358 · find_or_new
360 'string_index -find_or_new' => [ qw / foo bar baz / ]
362 Just like string_index except the find_x method is defined to call
364 the new method to create an object if there is no object already
365 stored under any of the keys you give as arguments.
366 number Accessor
368 A generic scalar-value accessor meta-method which serves as an abstrac‐
370 tion for basic "get_set" methods and numerous related interfaces
371 use Class::MakeMethods -MakerClass => "...",
373 string => [ 'foo', 'bar' ];
374 ...
375 $self->foo( 23 );
376 print $self->foo();
377 This meta-method extends the scalar meta-method, and supports the same
379 interfaces and parameters.
380 However, it generally treats values as numbers, and can not be used to
382 store strings or references.
383 Interfaces: In addition to those provided by "scalar", the following
385 calling interfaces are available.
386 -counter
388 Provides the numeric get_set behavior for *, and numeric *_incr and
389 *_reset methods.
390 Behaviors: In addition to those provided by "scalar", the following
392 types of accessor methods are available.
393 get_set
395 The get_set behavior is similar to the default scalar behavior
396 except that empty values are treated as zero.
397 increment
399 If no argument is provided, increments the hash_key value by 1. If
400 an argument is provided, the value is incremented by that amount.
401 Returns the increased value.
402 clear
404 Sets the value to zero.
405 boolean Accessor
407 A generic scalar-value accessor meta-method which serves as an abstrac‐
409 tion for basic "get_set" methods and numerous related interfaces
410 use Class::MakeMethods -MakerClass => "...",
412 string => [ 'foo', 'bar' ];
413 ...
414 $self->foo( 1 );
415 print $self->foo();
416 $self->clear_foo;
417 This meta-method extends the scalar meta-method, and supports the same
419 interfaces and parameters. However, it generally treats values as true-
420 or-false flags, and can not be used to store strings, numbers, or ref‐
421 erences.
422 Interfaces:
424 flag_set_clear (default)
426 Provides the get_set behavior for *, and set_* and clear_* methods
427 to set the value to true or false.
428 Behaviors: In addition to those provided by "scalar", the following
430 types of accessor methods are available.
431 get_set
433 The get_set behavior is similar to the get_set scalar behavior
434 except that empty or false values are treated as zero, and true
435 values are treated as zero.
436 set_true
438 Sets the value to one.
439 set_false
441 Sets the value to zero. =back
442 bits Accessor
444 A generic accessor for bit-field values.
446 The difference between 'Template::Generic:bits' and 'Tem‐
448 plate::Generic:boolean' is that all flags created with this meta-method
449 are stored in a single vector for space efficiency.
450 Interfaces: The following calling interfaces are available.
452 default
454 Provides get_set behavior for *, a set_* method which sets the
455 value to true and a clear_* method which sets the value to
456 false.
457 Also defines methods named bits, bit_fields, and bit_dump with
459 the behaviors below. These methods are shared across all of the
460 boolean meta-methods defined by a single class.
461 class_methods
463 .
464 Basic Behaviors: The following types of bit-level accessor methods
466 are available.
467 get_set
469 Returns the value of the named flag. If called with an argu‐
470 ment, it first sets the named flag to the truth-value of the
471 argument.
472 set_true
474 Sets the value to true.
475 set_false
477 Sets the value to false.
478 Group Methods: The following types of methods manipulate the over‐
480 all vector value.
481 bits
483 Returns the vector containing all of the bit fields (remember
484 however that a vector containing all 0 bits is still true).
485 bit_dump
487 Returns a hash of the flag-name/flag-value pairs.
488 bits_size
490 Returns the number of bits that can fit into the current vec‐
491 tor.
492 bits_complement
494 Returns the twos-complement of the vector.
495 bit_pos_get
497 Takes a single argument and returns the value of the bit stored
498 in that position.
499 bit_pos_set
501 Takes two arguments and sets the bit stored in the position of
502 the first argument to the value of the second argument.
503 Class Methods: The following types of class methods are available.
505 bit_names
507 Returns a list of all the flags by name.
508 array Accessor
510 Creates accessor methods for manipulating arrays of values.
512 Interfaces: The following calling interfaces are available.
514 default
516 Provides get_set behavior for *, and verb_* methods for the
517 non-get behaviors below.
518 minimal
520 Provides get_set behavior for *, and *_verb methods for clear
521 behavior.
522 get_set_items
524 Provides the get_set_items for *.
525 x_verb
527 Provides get_push behavior for *, and *_verb methods for the
528 non-get behaviors below.
529 get_set_ref
531 Provides the get_set_ref for *.
532 get_set_ref_help
534 Provides the get_set_ref for *, and verb_* methods for the non-
535 get behaviors below.
536 Behaviors: The following types of accessor methods are available.
538 get_set_items
540 Called with no arguments returns a reference to the array
541 stored in the slot.
542 Called with one simple scalar argument it treats the argument
544 as an index and returns the value stored under that index.
545 Called with more than one argument, treats them as a series of
547 index/value pairs and adds them to the array.
548 get_push
550 If arguments are passed, these values are pushed on to the
551 list; if a single array ref is passed, its values are used as
552 the arguments.
553 This method returns the list of values stored in the slot. In
555 an array context it returns them as an array and in a scalar
556 context as a reference to the array.
557 get_set_ref
559 If arguments are passed, these values are placed on the list,
560 replacing the current contents; if a single array ref is
561 passed, its values are used as the arguments.
562 This method returns the list of values stored in the slot. In
564 an array context it returns them as an array and in a scalar
565 context as a reference to the array.
566 get_set
568 If arguments are passed, these values are placed on the list,
569 replacing the current contents.
570 This method returns the list of values stored in the slot. In
572 an array context it returns them as an array and in a scalar
573 context as a reference to the array.
574 push
576 Append items to tail.
577 pop Remove an item from the tail.
579 shift
581 Remove an item from the front.
582 unshift
584 Prepend items to front.
585 splice
587 Remove or replace items.
588 clear
590 Remove all items.
591 count
593 Returns the number of item in the list.
594 hash Accessor
596 Creates accessor methods for manipulating hashes of key-value
598 pairs.
599 Interfaces: The following calling interfaces are available.
601 default
603 Provides get_set behavior for *, and *_verb methods for most of
604 the other behaviors below.
605 get_set_items
607 Provides the get_set_items for *.
608 Behaviors: The following types of accessor methods are available.
610 get_set_items
612 Called with no arguments returns a reference to the hash
613 stored.
614 Called with one simple scalar argument it treats the argument
616 as a key and returns the value stored under that key.
617 Called with more than one argument, treats them as a series of
619 key/value pairs and adds them to the hash.
620 get_push
622 Called with no arguments returns the hash stored, as a hash in
623 a list context or as a reference in a scalar context.
624 Called with one simple scalar argument it treats the argument
626 as a key and returns the value stored under that key.
627 Called with one array reference argument, the array elements
629 are considered to be be keys of the hash. x returns the list of
630 values stored under those keys (also known as a hash slice.)
631 Called with one hash reference argument, the keys and values of
633 the hash are added to the hash.
634 Called with more than one argument, treats them as a series of
636 key/value pairs and adds them to the hash.
637 get_set
639 Like get_push, except if called with more then one argument,
640 empties the current hash items before adding those arguments to
641 the hash.
642 push
644 Called with one hash reference argument, the keys and values of
645 the hash are added to the hash.
646 Called with more than one argument, treats them as a series of
648 key/value pairs and adds them to the hash.
649 keys
651 Returns a list of the keys of the hash.
652 values
654 Returns a list of the values in the hash.
655 tally
657 Takes a list of arguments and for each scalar in the list
658 increments the value stored in the hash and returns a list of
659 the current (after the increment) values.
660 exists
662 Takes a single key, returns whether that key exists in the
663 hash.
664 delete
666 Takes a list, deletes each key from the hash, and returns the
667 corresponding values.
668 clear
670 Resets hash to empty.
671 tiedhash Accessor
673 A variant of Generic:hash which initializes the hash by tieing it
675 to a caller-specified package.
676 See the documentation on "Generic:hash" for interfaces and behav‐
678 iors.
679 Parameters: The following parameters must be provided:
681 tie Required. The name of the class to tie to. Make sure you have
683 "use"d the required class.
684 args
686 Required. Additional arguments for the tie, as an array ref.
687 Example:
689 use Class::MakeMethods
691 tie_hash => [ hits => { tie => q/Tie::RefHash/, args => [] } ];
692 use Class::MakeMethods
694 tie_hash => [ [qw(hits errors)] => { tie => q/Tie::RefHash/, args => [] } ];
695 use Class::MakeMethods
697 tie_hash => [ { name => hits, tie => q/Tie::RefHash/, args => [] } ];
698 hash_of_arrays Accessor
700 Creates accessor methods for manipulating hashes of array-refs.
702 Interfaces: The following calling interfaces are available.
704 default
706 Provides get behavior for *, and *_verb methods for the other
707 behaviors below.
708 Behaviors: The following types of accessor methods are available.
710 get Returns all the values for all the given keys, in order. If no
712 keys are given, returns all the values (in an unspecified key
713 order).
714 The result is returned as an arrayref in scalar context. This
716 arrayref is not part of the data structure; messing with it
717 will not affect the contents directly (even if a single key was
718 provided as argument.)
719 If any argument is provided which is an arrayref, then the mem‐
721 bers of that array are used as keys. Thus, the trivial empty-
722 key case may be utilized with an argument of [].
723 keys
725 Returns the keys of the hash. As an arrayref in scalar con‐
726 text.
727 exists
729 Takes a list of keys, and returns whether all of the key exists
730 in the hash (i.e., the "and" of whether the individual keys
731 exist).
732 delete
734 Takes a list, deletes each key from the hash.
735 push
737 Takes a key, and some values. Pushes the values onto the list
738 denoted by the key. If the first argument is an arrayref, then
739 each element of that arrayref is treated as a key and the ele‐
740 ments pushed onto each appropriate list.
741 pop Takes a list of keys, and pops each one. Returns the list of
743 popped elements. undef is returned in the list for each key
744 that is has an empty list.
745 unshift
747 Like push, only the from the other end of the lists.
748 shift
750 Like pop, only the from the other end of the lists.
751 splice
753 Takes a key, offset, length, and a values list. Splices the
754 list named by the key. Anything from the offset argument
755 (inclusive) may be omitted. See "splice" in perlfunc.
756 clear
758 Takes a list of keys. Resets each named list to empty (but
759 does not delete the keys.)
760 count
762 Takes a list of keys. Returns the sum of the number of ele‐
763 ments for each named list.
764 index
766 Takes a key, and a list of indices. Returns a list of each
767 item at the corresponding index in the list of the given key.
768 Uses undef for indices beyond range.
769 remove
771 Takes a key, and a list of indices. Removes each corresponding
772 item from the named list. The indices are effectively looked
773 up at the point of call -- thus removing indices 3, 1 from list
774 (a, b, c, d) will remove (d) and (b).
775 sift
777 Takes a key, and a set of named arguments, which may be a list
778 or a hash ref. Removes list members based on a grep-like
779 approach.
780 filter
782 The filter function used (as a coderef). Is passed two
783 arguments, the value compared against, and the value in the
784 list that is potential for grepping out. If returns true,
785 the value is removed. Default is "sub { $_[0] == $_[1] }".
786 keys
788 The list keys to sift through (as an arrayref). Unknown
789 keys are ignored. Default: all the known keys.
790 values
792 The values to sift out (as an arrayref). Default:
793 "[undef]"
794 object Accessor
796 Creates accessor methods for manipulating references to objects.
798 In addition to creating a method to get and set the object refer‐
800 ence, the meta-method can also define forwarded methods that auto‐
801 matically pass calls onto the object stored in that slot; see the
802 description of the 'delegate' parameter below.
803 Interfaces: The following calling interfaces are available.
805 default
807 Provides get_set behavior for *, clear behavior for 'delete_*',
808 and forwarding methods for any values in the method's 'dele‐
809 gate' or 'soft_delegate' parameters.
810 get_and_set
812 Provides named get method, set_x and clear_x methods.
813 get_init_and_set
815 Provides named get_init method, set_x and clear_x methods.
816 Behaviors: The following types of accessor methods are available.
818 get_set
820 The get_set method, if called with a reference to an object of
821 the given class as the first argument, stores it.
822 If called with any other arguments, creates and stores a new
824 object, passing the arguemnts to the new() method for the
825 object.
826 If called without arguments, returns the current value, which
828 may be undefined if one has not been stored yet.
829 get_set_init
831 The get_set_init method, if called with a reference to an
832 object of the given class as the first argument, stores it.
833 If the slot is not filled yet it creates an object by calling
835 the given new method of the given class. Any arguments passed
836 to the get_set_init method are passed on to new.
837 In all cases the object now stored is returned.
839 get_init
841 If the instance is empty, creates and stores a new one. Returns
842 the instance.
843 get Returns the current value, which may be undefined if one has
845 not been stored yet.
846 set If called with a reference to an object of the given class as
848 the first argument, stores it.
849 If called with any other arguments, creates and stores a new
851 object, passing the arguments to the new() method.
852 If called without arguments, creates and stores a new object,
854 without any arguments to the new() method.
855 clear
857 Removes the reference value.
858 forwarding
860 If a 'delegate' or 'soft_delegate' parameter is provided, meth‐
861 ods with those names are created that are forwarded directly to
862 the object in the slot, as described below.
863 Parameters: The following parameters are supported:
865 class
867 Required. The type of object that will be stored.
868 new_method
870 The name of the method to call on the above class to create a
871 new instance. Defaults to 'new'.
872 delegate
874 The methods to forward to the object. Can contain a method
875 name, a string of space-spearated method names, or an array of
876 method names. This type of method will croak if it is called
877 when the target object is not defined.
878 soft_delegate
880 The methods to forward to the object, if it is present. Can
881 contain a method name, a string of space-spearated method
882 names, or an array of method names. This type of method will
883 return nothing if it is called when the target object is not
884 defined.
885 instance Accessor
887 Creates methods to handle an instance of the calling class.
889 PROFILES
891 default
893 Provides named get method, and verb_x set, new, and clear meth‐
894 ods.
895 -implicit_new
897 Provides named get_init method, and verb_x set, and clear meth‐
898 ods.
899 -x_verb
901 Provides named get method, and x_verb set, new, and clear meth‐
902 ods.
903 Behaviors: The following types of accessor methods are available.
905 get Returns the value of the instance parameter, which may be unde‐
907 fined if one has not been stored yet.
908 get_init
910 If the instance is empty, creates and stores a new one. Returns
911 the instance.
912 set Takes a single argument and sets the instance to that value.
914 new Creates and stores a new instance.
916 clear
918 Sets the instance parameter to undef.
919 Parameters: The following parameters are supported:
921 instance
923 Holds the instance reference. Defaults to undef
924 new_method
926 The name of the method to call when creating a new instance.
927 Defaults to 'new'.
928 array_of_objects Accessor
930 Creates accessor methods for manipulating references to arrays of
932 object references.
933 Operates like "Generic:array", but prior to adding any item to the
935 array, it first checks to see if it is an instance of the desig‐
936 nated class, and if not passes it as an argument to that class's
937 new method and stores the result instead.
938 Forwarded methods return a list of the results returned by "map"ing
940 the method over each object in the array.
941 See the documentation on "Generic:array" for interfaces and behav‐
943 iors.
944 Parameters: The following parameters are supported:
946 class
948 Required. The type of object that will be stored.
949 delegate
951 The methods to forward to the object. Can contain a method
952 name, a string of space-spearated method names, or an array of
953 method names.
954 new_method
956 The name of the method to call on the above class to create a
957 new instance. Defaults to 'new'.
958 code Accessor
960 Creates accessor methods for manipulating references to subrou‐
962 tines.
963 Interfaces: The following calling interfaces are available.
965 default
967 Provides the call_set functionality.
968 method
970 Provides the call_method functionality.
971 Behaviors: The following types of accessor methods are available.
973 call_set
975 If called with one argument which is a CODE reference, it
976 installs that code in the slot. Otherwise it runs the code
977 stored in the slot with whatever arguments (including none)
978 were passed in.
979 call_method
981 Just like call_set, except the code is called like a method,
982 with $self as its first argument. Basically, you are creating a
983 method which can be different for each object.
984 code_or_scalar Accessor
986 Creates accessor methods for manipulating either strings or refer‐
988 ences to subroutines.
989 You can store any scalar value; code refs are executed when you
991 retrieve the value, while other scalars are returned as-is.
992 Interfaces: The following calling interfaces are available.
994 default
996 Provides the call_set functionality.
997 method
999 Provides the call_method functionality.
1000 eiffel
1002 Provides the named get_method, and a helper set_* method.
1003 Behaviors: The following types of accessor methods are available.
1005 get_set_call
1007 If called with an argument, either a CODE reference or some
1008 other scalar, it installs that code in the slot. Otherwise, if
1009 the current value runs the code stored in the slot with what‐
1010 ever arguments (including none) were passed in.
1011 get_set_method
1013 Just like call_set, except the code is called like a method,
1014 with $self as its first argument. Basically, you are creating a
1015 method which can be different for each object.
1016
1018 See Class::MakeMethods for general information about this distribution.
1019 See Class::MakeMethods::Template for information about this family of
1021 subclasses.
1022perl v5.8.8 2004-09-06 MakeMethods::Template::Generic(3)