/usr/share/perl5/Class/MakeMethods/Docs/Catalog.pod is in libclass-makemethods-perl 1.01-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 | =head1 NAME
Class::MakeMethods::Docs::Catalog - List of Makable Method Types
=head1 DESCRIPTION
This document lists the various subclasses of Class::MakeMethods included
in this distribution, and the method types each one provides.
See the documentation for each implementation for more details
about the features it provides.
For each class, a parenthetical comment indicates whether the methods it generates are applicable to individual blessed objects (Instances), to class data (Global), or both (Any)
=head2 Scoping
The final part of the name of a method-generating subclass typically indicates the scope or applicability of the methods it generates
=over 4
=item Hash
For object instances based on blessed hashes with named values.
=item Array
For object instances based on blessed arrays with positional values.
=item Scalar
For object instances based on blessed scalars with a single value.
=item InsideOut
For any object instance regardless of underlying data type.
=item Ref
For any object instance regardless of underlying data type.
=item Inheritable
For data which can be set at the class, subclass, or instance level.
=item Class
For class data shared by all instances but different for each subclass
=item ClassVar
For class data shared by all instances but different for each subclass
=item ClassInherit
For class data shared by all instances but different for each subclass
=item Global
For global data shared by a class and all its instances and subclasses
=item PackageVar
For global data shared by a class and all its instances and subclasses
=item Universal
# General method types that are widely applicable
=back
=head2 Summary Charts
This table shows which scopes are available in each generator family:
SCOPING Basic Standard Evaled Composite Template
Hash + + + + +
Array + + + +
Scalar +
InsideOut +
Ref +
Inheritable + + +
Class +
ClassVar +
ClassInherit +
Global + + + +
PackageVar +
Universal + +
This table shows which types of methods are typically available in each generator family:
METHOD Basic Standard Evaled Composite Template
new + + + +
scalar + + + +
string +
string_index +
number +
boolean +
boolean_index +
bits +
array + + + +
struct +
hash + + + +
hash_of_arrays +
tiedhash +
object + + +
instance +
array_of_objects +
code +
code_or_scalar +
=head1 BASIC CLASSES
=head2 Basic::Hash (Instances)
Methods for objects based on blessed hashes. See L<Class::MakeMethods::Basic::Hash> for details.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values in each instance
=item *
array: get and set values stored in an array refered to in each
instance
=item *
hash: get and set values in a hash refered to in each instance
=back
=head2 Basic::Array (Instances)
Methods for manipulating positional values in arrays. See L<Class::MakeMethods::Basic::Array> for details.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values in each instance
=item *
array: get and set values stored in an array refered to in each
instance
=item *
hash: get and set values in a hash refered to in each instance
=back
=head2 Basic::Global (Global)
Global methods are not instance-dependent; calling them by class
name or from any instance or subclass will consistently access the
same value. See L<Class::MakeMethods::Basic::Global> for details.
=over 4
=item *
scalar: get and set a global scalar value
=item *
array: get and set values in a global array
=item *
hash: get and set values in a global hash
=back
=head1 STANDARD CLASSES
=head2 Standard::Hash (Instances)
Methods for objects based on blessed hashes. See L<Class::MakeMethods::Standard::Hash> for details.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values in each instance
=item *
array: get and set values stored in an array refered to in each
instance
=item *
hash: get and set values in a hash refered to in each instance
=item *
object: access an object refered to by each instance
=back
=head2 Standard::Array (Instances)
Methods for manipulating positional values in arrays. See L<Class::MakeMethods::Standard::Array> for details.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values in each instance
=item *
array: get and set values stored in an array refered to in each
instance
=item *
hash: get and set values in a hash refered to in each instance
=item *
object: access an object refered to by each instance
=back
=head2 Standard::Global (Global)
Methods for manipulating global data. See L<Class::MakeMethods::Standard::Global> for details.
=over 4
=item *
scalar: get and set global scalar
=item *
array: get and set values stored in a global array
=item *
hash: get and set values in a global hash
=item *
object: global access to an object ref
=back
=head2 Standard::Inheritable (Any)
Methods for manipulating data which may be overridden per class or instance. Uses external data storage, so it works with objects of any underlying data type. See L<Class::MakeMethods::Standard::Inheritable> for details.
=over 4
=item *
scalar: get and set scalar values for each instance or class
=back
=head1 COMPOSITE CLASSES
=head2 Composite::Hash (Instances)
Methods for objects based on blessed hashes. See L<Class::MakeMethods::Composite::Hash> for details.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values in each instance
=item *
array: get and set values stored in an array refered to in each
instance
=item *
hash: get and set values in a hash refered to in each instance
=item *
object: access an object refered to by each instance
=back
=head2 Composite::Array (Instances)
Methods for manipulating positional values in arrays. See L<Class::MakeMethods::Composite::Array> for details.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values in each instance
=item *
array: get and set values stored in an array refered to in each
instance
=item *
hash: get and set values in a hash refered to in each instance
=item *
object: access an object refered to by each instance
=back
=head2 Composite::Global (Global)
Methods for manipulating global data. See L<Class::MakeMethods::Composite::Global> for details.
=over 4
=item *
scalar: get and set global scalar
=item *
array: get and set values stored in a global array
=item *
hash: get and set values in a global hash
=item *
object: global access to an object ref
=back
=head2 Composite::Inheritable (Any)
Methods for manipulating data which may be overridden per class or instance. Uses external data storage, so it works with objects of any underlying data type. See L<Class::MakeMethods::Composite::Inheritable> for details.
=over 4
=item *
scalar: get and set scalar values for each instance or class
=item *
hook: create a subroutine intended to have operations added to it
=back
=head2 Composite::Universal (Any)
Methods for padding pre- and post-conditions to any class. See L<Class::MakeMethods::Composite::Universal> for details.
=over 4
=item *
patch: add pre and post operations to an existing subroutine
=back
=head1 TEMPLATE CLASSES
=head2 Template::Universal (Any)
Meta-methods for any type of object. See L<Class::MakeMethods::Template::Universal>.
=over 4
=item *
no_op - a method with an empty body
=item *
croak - a method which will croak if called
=item *
method_init - calls other methods from a list of method name => argument pairs
=item *
forward_methods - delegates to an object provided by another method
=back
=head2 Template::Ref (Any Instance)
Methods for deep copies and comparisons. See L<Class::MakeMethods::Template::Ref>.
=over 4
=item *
clone: make a deep copy of an object instance
=item *
prototype: make new objects by cloning a typical instance
=item *
compare: compare one object to another
=back
=head2 Template::Generic (Abstract)
The remaining subclasses inherit a similar collection of templates from Template::Generic, and provide a different type of scoping or binding for the functionality defined by the Generic template. See L<Class::MakeMethods::Template::Generic> for details.
=head2 Template::Hash (Instances)
The most commonly used implementation, for objects based on blessed hashes. See L<Class::MakeMethods::Template::Hash>.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values in each instance
=item *
string: get and set string values in each instance
=item *
number: get and set numeric values in each instance
=item *
boolean: get and set boolean values in each instance
=item *
bits: get and set boolean values stored in a single value in each
instance
=item *
array: get and set values stored in an array refered to in each
instance
=item *
struct - methods for acccessing values which are stored by
position in an array
=item *
hash: get and set values in a hash refered to in each instance
=item *
tiedhash: get and set values in a tied hash refered to in each
instance
=item *
hash_of_arrays: for references to hashes of arrays contained in each
instance
=item *
object: set or access a reference to an object contained in each
instance
=item *
array_of_objects: manipulate an array of object references within in
each instance
=item *
code: set or call a function reference contained in each instance
=back
=head2 Template::Array (Instances)
Methods for manipulating positional values in arrays. See L<Class::MakeMethods::Template::Array>.
=over 4
=item *
new: create and copy array instances
=item *
scalar: get and set scalar values in a given array position
=item *
string: get and set string values in a given array position
=item *
number: get and set numeric values in a given array position
=item *
boolean: get and set boolean values in a given array position
=item *
builtin_isa: generates a wrapper around some builtin function,
cacheing the results in the object and providing a by-name interface
=back
=head2 Template::Scalar (Instances)
For objects based on blessed scalars. See L<Class::MakeMethods::Template::Scalar>.
Note that these objects can generally only have one value accessor method, as all such accessors will refer to the same value.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values in each instance
=item *
string: get and set a string value in each instance
=item *
number: get and set a numeric value in each instance
=item *
boolean: get and set a boolean value in each instance
=item *
bits: get and set boolean values stored in a single value in each
instance
=item *
code: set or call a function reference contained in each instance
=back
=head2 Template::InsideOut (Instances)
Stores values for objects in an external location hashed by identity. See L<Class::MakeMethods::Template::InsideOut>.
Note that while the below constructor creates and returns scalar
references, accessor methods can be created with this implementation
for use with any type of object.
=over 4
=item *
new: create and copy instances
=item *
scalar: get and set scalar values associated with each instance
=item *
string: get and set string values associated with each instance
=item *
string_index: get and set string values associated with each
instance, and maintain an index of instances by value
=item *
number: get and set numeric values associated with each instance
=item *
boolean: get and set boolean values associated with each instance
=item *
boolean_index: get and set boolean values associated with each instance, and maintain a list of items which have the flag set
=item *
bits: get and set boolean values stored in a single value associated with each
instance
=item *
array: get and set values stored in an array associated with each
instance
=item *
hash: get and set values in a hash associated with each instance
=item *
code: set or call a function reference associated with each instance
=back
=head2 Template::Global (Global)
Global methods are not instance-dependent; calling them by class
name or from any instance will consistently access the same value. See L<Class::MakeMethods::Template::Static>.
=over 4
=item *
scalar: get and set a global scalar value
=item *
string: get and set a global string value
=item *
number: get and set a global number value
=item *
boolean: get and set a global boolean value
=item *
array: get and set values in a global array
=item *
hash: get and set values in a global hash
=item *
tiedhash: get and set values in a global tied hash
=item *
hash_of_arrays: get and set values in a global hash of arrays
=item *
object: set and access a global reference to an object
=item *
instance: set and access a global reference to an object of the declaring class
=item *
code: set and access a global reference to a subroutine.
=back
=head2 Template::PackageVar (Global)
PackageVar methods access a variable in the declaring package. Thus,
they have the same effect as Static methods, while keeping their
value accessible via the symbol table. See L<Class::MakeMethods::Template::PackageVar>.
=over 4
=item *
scalar: get and set a global scalar value
=item *
string: get and set a global string value
=item *
number: get and set a global number value
=item *
boolean: get and set a global boolean value
=item *
array: get and set values in a global array
=item *
hash: get and set values in a global hash
=back
=head2 Template::Class (Global)
Class methods are similar to Static methods, except that each subclass and its instances will access a distinct value. See L<Class::MakeMethods::Template::Class>.
=over 4
=item *
scalar: get and set a class-specific scalar value
=item *
string: get and set a class-specific string value
=item *
number: get and set a class-specific number value
=item *
boolean: get and set a class-specific boolean value
=item *
array: get and set values in a class-specific array
=item *
hash: get and set values in a class-specific hash
=back
=head2 Template::ClassVar (Global)
ClassVar methods access a variable in the package on which they
are called. Thus, they have the same effect as Class methods,
while keeping their value accessible via the symbol table, like
PackageVar. See L<Class::MakeMethods::Template::ClassVar>.
=over 4
=item *
scalar: get and set a class-specific scalar value
=item *
string: get and set a class-specific string value
=item *
number: get and set a class-specific number value
=item *
boolean: get and set a class-specific boolean value
=item *
array: get and set values in a class-specific array
=item *
hash: get and set values in a class-specific hash
=back
=head2 Template::ClassInherit (Global)
ClassInherit methods are an intermediate point between Static and Class methods; subclasses inherit their superclass's value until they set their own value, after which they become distinct. See L<Class::MakeMethods::Template::ClassInherit>.
=over 4
=item *
scalar: get and set an inheritable class-specific scalar value
=item *
string: get and set an inheritable class-specific string value
=item *
number: get and set an inheritable class-specific number value
=item *
boolean: get and set an inheritable class-specific boolean value
=item *
array: get and set values in an inheritable class-specific array
=item *
hash: get and set values in an inheritable class-specific hash
=back
=head2 Template::Inheritable (Any)
Methods for manipulating data which may be overridden per class or instance. Uses external data storage, so it works with objects of any underlying data type. See L<Class::MakeMethods::Template::Inheritable> for details.
=over 4
=item *
scalar: get and set scalar values for each instance or class
=item *
string: get and set string values for each instance or class
=item *
number: get and set numeric values for each instance or class
=item *
boolean: get and set boolean values for each instance or class
=item *
hash: get and set values in a hash refered to in each instance
=back
=head1 SEE ALSO
See L<Class::MakeMethods> for general information about this distribution.
=cut
|