local-lib5/man/man3/Moose::Meta::TypeConstraint::Class.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 "Moose::Meta::TypeConstraint::Class 3"
 132 .TH Moose::Meta::TypeConstraint::Class 3 "2009-11-19" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Moose::Meta::TypeConstraint::Class \- Class/TypeConstraint parallel hierarchy
 135 .SH "DESCRIPTION"
 136 .IX Header "DESCRIPTION"
 137 This class represents type constraints for a class.
 138 .SH "INHERITANCE"
 139 .IX Header "INHERITANCE"
 140 \&\f(CW\*(C`Moose::Meta::TypeConstraint::Class\*(C'\fR is a subclass of
 141 Moose::Meta::TypeConstraint.
 142 .SH "METHODS"
 143 .IX Header "METHODS"
 144 .IP "\fBMoose::Meta::TypeConstraint::Class\->new(%options)\fR" 4
 145 .IX Item "Moose::Meta::TypeConstraint::Class->new(%options)"
 146 This creates a new class type constraint based on the given
 147 \&\f(CW%options\fR.
 148 .Sp
 149 It takes the same options as its parent, with two exceptions. First,
 150 it requires an additional option, \f(CW\*(C`class\*(C'\fR, which is name of the
 151 constraint's class.  Second, it automatically sets the parent to the
 152 \&\f(CW\*(C`Object\*(C'\fR type.
 153 .Sp
 154 The constructor also overrides the hand optimized type constraint with
 155 one it creates internally.
 156 .IP "\fB$constraint\->class\fR" 4
 157 .IX Item "$constraint->class"
 158 Returns the class name associated with the constraint.
 159 .IP "\fB$constraint\->parents\fR" 4
 160 .IX Item "$constraint->parents"
 161 Returns all the type's parent types, corresponding to its parent
 162 classes.
 163 .IP "\fB$constraint\->is_subtype_of($type_name_or_object)\fR" 4
 164 .IX Item "$constraint->is_subtype_of($type_name_or_object)"
 165 If the given type is also a class type, then this checks that the
 166 type's class is a subclass of the other type's class.
 167 .Sp
 168 Otherwise it falls back to the implementation in
 169 Moose::Meta::TypeConstraint.
 170 .IP "\fB$constraint\->create_child_type(%options)\fR" 4
 171 .IX Item "$constraint->create_child_type(%options)"
 172 This returns a new Moose::Meta::TypeConstraint object with the type
 173 as its parent.
 174 .Sp
 175 Note that it does \fInot\fR return a
 176 \&\f(CW\*(C`Moose::Meta::TypeConstraint::Class\*(C'\fR object!
 177 .IP "\fB$constraint\->get_message($value)\fR" 4
 178 .IX Item "$constraint->get_message($value)"
 179 This is the same as \*(L"get_message\*(R" in Moose::Meta::TypeConstraint except
 180 that it explicitly says \f(CW\*(C`isa\*(C'\fR was checked. This is to help users deal
 181 with accidentally autovivified type constraints.
 182 .SH "BUGS"
 183 .IX Header "BUGS"
 184 All complex software has bugs lurking in it, and this module is no
 185 exception. If you find a bug please either email me, or add the bug
 186 to cpan\-RT.
 187 .SH "AUTHOR"
 188 .IX Header "AUTHOR"
 189 Yuval Kogman <nothingmuch@cpan.org>
 190 .SH "COPYRIGHT AND LICENSE"
 191 .IX Header "COPYRIGHT AND LICENSE"
 192 Copyright 2006\-2009 by Infinity Interactive, Inc.
 193 .PP
 194 <http://www.iinteractive.com>
 195 .PP
 196 This library is free software; you can redistribute it and/or modify
 197 it under the same terms as Perl itself.