local-lib5/man/man3/Mouse::Meta::Class.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "Mouse::Meta::Class 3"
 127 .TH Mouse::Meta::Class 3 "2009-12-07" "perl v5.8.7" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 Mouse::Meta::Class \- The Mouse class metaclass
 134 .SH "VERSION"
 135 .IX Header "VERSION"
 136 This document describes Mouse version 0.43
 137 .SH "METHODS"
 138 .IX Header "METHODS"
 139 .ie n .SS """initialize(ClassName) \-> Mouse::Meta::Class"""
 140 .el .SS "\f(CWinitialize(ClassName) \-> Mouse::Meta::Class\fP"
 141 .IX Subsection "initialize(ClassName) -> Mouse::Meta::Class"
 142 Finds or creates a \f(CW\*(C`Mouse::Meta::Class\*(C'\fR instance for the given ClassName. Only
 143 one instance should exist for a given class.
 144 .ie n .SS """name \-> ClassName"""
 145 .el .SS "\f(CWname \-> ClassName\fP"
 146 .IX Subsection "name -> ClassName"
 147 Returns the name of the owner class.
 148 .ie n .SS """superclasses \-> ClassNames"" ""superclass(ClassNames)"""
 149 .el .SS "\f(CWsuperclasses \-> ClassNames\fP \f(CWsuperclass(ClassNames)\fP"
 150 .IX Subsection "superclasses -> ClassNames superclass(ClassNames)"
 151 Gets (or sets) the list of superclasses of the owner class.
 152 .ie n .SS """add_method(name => CodeRef)"""
 153 .el .SS "\f(CWadd_method(name => CodeRef)\fP"
 154 .IX Subsection "add_method(name => CodeRef)"
 155 Adds a method to the owner class.
 156 .ie n .SS """has_method(name) \-> Bool"""
 157 .el .SS "\f(CWhas_method(name) \-> Bool\fP"
 158 .IX Subsection "has_method(name) -> Bool"
 159 Returns whether we have a method with the given name.
 160 .ie n .SS """get_method(name) \-> Mouse::Meta::Method | undef"""
 161 .el .SS "\f(CWget_method(name) \-> Mouse::Meta::Method | undef\fP"
 162 .IX Subsection "get_method(name) -> Mouse::Meta::Method | undef"
 163 Returns a Mouse::Meta::Method with the given name.
 164 .PP
 165 Note that you can also use \f(CW\*(C`$metaclass\->name\->can($name)\*(C'\fR for a method body.
 166 .ie n .SS """get_method_list \-> Names"""
 167 .el .SS "\f(CWget_method_list \-> Names\fP"
 168 .IX Subsection "get_method_list -> Names"
 169 Returns a list of method names which are defined in the local class.
 170 If you want a list of all applicable methods for a class, use the
 171 \&\f(CW\*(C`get_all_methods\*(C'\fR method.
 172 .ie n .SS """get_all_methods \-> (Mouse::Meta::Method)"""
 173 .el .SS "\f(CWget_all_methods \-> (Mouse::Meta::Method)\fP"
 174 .IX Subsection "get_all_methods -> (Mouse::Meta::Method)"
 175 Return the list of all Mouse::Meta::Method instances associated with
 176 the class and its superclasses.
 177 .ie n .SS """add_attribute(name => spec | Mouse::Meta::Attribute)"""
 178 .el .SS "\f(CWadd_attribute(name => spec | Mouse::Meta::Attribute)\fP"
 179 .IX Subsection "add_attribute(name => spec | Mouse::Meta::Attribute)"
 180 Begins keeping track of the existing Mouse::Meta::Attribute for the owner
 181 class.
 182 .ie n .SS """has_attribute(Name) \-> Bool"""
 183 .el .SS "\f(CWhas_attribute(Name) \-> Bool\fP"
 184 .IX Subsection "has_attribute(Name) -> Bool"
 185 Returns whether we have a Mouse::Meta::Attribute with the given name.
 186 .ie n .SS """get_attribute Name \-> Mouse::Meta::Attribute | undef"""
 187 .el .SS "\f(CWget_attribute Name \-> Mouse::Meta::Attribute | undef\fP"
 188 .IX Subsection "get_attribute Name -> Mouse::Meta::Attribute | undef"
 189 Returns the Mouse::Meta::Attribute with the given name.
 190 .ie n .SS """get_attribute_list \-> Names"""
 191 .el .SS "\f(CWget_attribute_list \-> Names\fP"
 192 .IX Subsection "get_attribute_list -> Names"
 193 Returns a list of attribute names which are defined in the local
 194 class. If you want a list of all applicable attributes for a class,
 195 use the \f(CW\*(C`get_all_attributes\*(C'\fR method.
 196 .ie n .SS """get_all_attributes \-> (Mouse::Meta::Attribute)"""
 197 .el .SS "\f(CWget_all_attributes \-> (Mouse::Meta::Attribute)\fP"
 198 .IX Subsection "get_all_attributes -> (Mouse::Meta::Attribute)"
 199 Returns the list of all Mouse::Meta::Attribute instances associated with
 200 this class and its superclasses.
 201 .ie n .SS """linearized_isa \-> [ClassNames]"""
 202 .el .SS "\f(CWlinearized_isa \-> [ClassNames]\fP"
 203 .IX Subsection "linearized_isa -> [ClassNames]"
 204 Returns the list of classes in method dispatch order, with duplicates removed.
 205 .ie n .SS """new_object(Parameters) \-> Instance"""
 206 .el .SS "\f(CWnew_object(Parameters) \-> Instance\fP"
 207 .IX Subsection "new_object(Parameters) -> Instance"
 208 Creates a new instance.
 209 .ie n .SS """clone_object(Instance, Parameters) \-> Instance"""
 210 .el .SS "\f(CWclone_object(Instance, Parameters) \-> Instance\fP"
 211 .IX Subsection "clone_object(Instance, Parameters) -> Instance"
 212 Clones the given instance which must be an instance governed by this
 213 metaclass.
 214 .ie n .SS """throw_error(Message, Parameters)"""
 215 .el .SS "\f(CWthrow_error(Message, Parameters)\fP"
 216 .IX Subsection "throw_error(Message, Parameters)"
 217 Throws an error with the given message.
 218 .SH "SEE ALSO"
 219 .IX Header "SEE ALSO"
 220 Mouse::Meta::Module
 221 .PP
 222 Moose::Meta::Class
 223 .PP
 224 Class::MOP::Class