local-lib5/man/man3/Class::MOP::Method.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Class::MOP::Method 3"
 132 .TH Class::MOP::Method 3 "2009-11-18" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Class::MOP::Method \- Method Meta Object
 135 .SH "DESCRIPTION"
 136 .IX Header "DESCRIPTION"
 137 The Method Protocol is very small, since methods in Perl 5 are just
 138 subroutines in a specific package. We provide a very basic
 139 introspection interface.
 140 .SH "METHODS"
 141 .IX Header "METHODS"
 142 .ie n .IP "\fBClass::MOP::Method\->wrap($code, \fB%options\fB)\fR" 4
 143 .el .IP "\fBClass::MOP::Method\->wrap($code, \f(CB%options\fB)\fR" 4
 144 .IX Item "Class::MOP::Method->wrap($code, %options)"
 145 This is the constructor. It accepts a method body in the form of
 146 either a code reference or a Class::MOP::Method instance, followed
 147 by a hash of options.
 148 .Sp
 149 The options are:
 150 .RS 4
 151 .IP "* name" 8
 152 .IX Item "name"
 153 The method name (without a package name). This is required if \f(CW$code\fR
 154 is a coderef.
 155 .IP "* package_name" 8
 156 .IX Item "package_name"
 157 The package name for the method. This is required if \f(CW$code\fR is a
 158 coderef.
 159 .IP "* associated_metaclass" 8
 160 .IX Item "associated_metaclass"
 161 An optional Class::MOP::Class object. This is the metaclass for the
 162 method's class.
 163 .RE
 164 .RS 4
 165 .RE
 166 .IP "\fB$metamethod\->clone(%params)\fR" 4
 167 .IX Item "$metamethod->clone(%params)"
 168 This makes a shallow clone of the method object. In particular,
 169 subroutine reference itself is shared between all clones of a given
 170 method.
 171 .Sp
 172 When a method is cloned, the original method object will be available
 173 by calling \f(CW\*(C`original_method\*(C'\fR on the clone.
 174 .IP "\fB$metamethod\->body\fR" 4
 175 .IX Item "$metamethod->body"
 176 This returns a reference to the method's subroutine.
 177 .IP "\fB$metamethod\->name\fR" 4
 178 .IX Item "$metamethod->name"
 179 This returns the method's name
 180 .IP "\fB$metamethod\->package_name\fR" 4
 181 .IX Item "$metamethod->package_name"
 182 This returns the method's package name.
 183 .IP "\fB$metamethod\->fully_qualified_name\fR" 4
 184 .IX Item "$metamethod->fully_qualified_name"
 185 This returns the method's fully qualified name (package name and
 186 method name).
 187 .IP "\fB$metamethod\->associated_metaclass\fR" 4
 188 .IX Item "$metamethod->associated_metaclass"
 189 This returns the Class::MOP::Class object for the method, if one
 190 exists.
 191 .IP "\fB$metamethod\->original_method\fR" 4
 192 .IX Item "$metamethod->original_method"
 193 If this method object was created as a clone of some other method
 194 object, this returns the object that was cloned.
 195 .IP "\fB$metamethod\->original_name\fR" 4
 196 .IX Item "$metamethod->original_name"
 197 This returns the method's original name, wherever it was first
 198 defined.
 199 .Sp
 200 If this method is a clone of a clone (of a clone, etc.), this method
 201 returns the name from the \fIfirst\fR method in the chain of clones.
 202 .IP "\fB$metamethod\->original_package_name\fR" 4
 203 .IX Item "$metamethod->original_package_name"
 204 This returns the method's original package name, wherever it was first
 205 defined.
 206 .Sp
 207 If this method is a clone of a clone (of a clone, etc.), this method
 208 returns the package name from the \fIfirst\fR method in the chain of
 209 clones.
 210 .IP "\fB$metamethod\->original_fully_qualified_name\fR" 4
 211 .IX Item "$metamethod->original_fully_qualified_name"
 212 This returns the method's original fully qualified name, wherever it
 213 was first defined.
 214 .Sp
 215 If this method is a clone of a clone (of a clone, etc.), this method
 216 returns the fully qualified name from the \fIfirst\fR method in the chain
 217 of clones.
 218 .IP "\fB$metamethod\->attach_to_class($metaclass)\fR" 4
 219 .IX Item "$metamethod->attach_to_class($metaclass)"
 220 Given a Class::MOP::Class object, this method sets the associated
 221 metaclass for the method. This will overwrite any existing associated
 222 metaclass.
 223 .IP "\fB$metamethod\->detach_from_class\fR" 4
 224 .IX Item "$metamethod->detach_from_class"
 225 Removes any associated metaclass object for the method.
 226 .IP "\fB$metamethod\->execute(...)\fR" 4
 227 .IX Item "$metamethod->execute(...)"
 228 This executes the method. Any arguments provided will be passed on to
 229 the method itself.
 230 .IP "\fBClass::MOP::Method\->meta\fR" 4
 231 .IX Item "Class::MOP::Method->meta"
 232 This will return a Class::MOP::Class instance for this class.
 233 .Sp
 234 It should also be noted that Class::MOP will actually bootstrap
 235 this module by installing a number of attribute meta-objects into its
 236 metaclass.
 237 .SH "AUTHORS"
 238 .IX Header "AUTHORS"
 239 Stevan Little <stevan@iinteractive.com>
 240 .SH "COPYRIGHT AND LICENSE"
 241 .IX Header "COPYRIGHT AND LICENSE"
 242 Copyright 2006\-2009 by Infinity Interactive, Inc.
 243 .PP
 244 <http://www.iinteractive.com>
 245 .PP
 246 This library is free software; you can redistribute it and/or modify
 247 it under the same terms as Perl itself.