.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Moose::Meta::TypeConstraint::Class 3pm"
.TH Moose::Meta::TypeConstraint::Class 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Moose::Meta::TypeConstraint::Class \- Class/TypeConstraint parallel hierarchy
.SH VERSION
.IX Header "VERSION"
version 2.2207
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class represents type constraints for a class.
.SH INHERITANCE
.IX Header "INHERITANCE"
\&\f(CW\*(C`Moose::Meta::TypeConstraint::Class\*(C'\fR is a subclass of
Moose::Meta::TypeConstraint.
.SH METHODS
.IX Header "METHODS"
.SS Moose::Meta::TypeConstraint::Class\->new(%options)
.IX Subsection "Moose::Meta::TypeConstraint::Class->new(%options)"
This creates a new class type constraint based on the given
\&\f(CW%options\fR.
.PP
It takes the same options as its parent, with two exceptions. First,
it requires an additional option, \f(CW\*(C`class\*(C'\fR, which is name of the
constraint's class.  Second, it automatically sets the parent to the
\&\f(CW\*(C`Object\*(C'\fR type.
.PP
The constructor also overrides the hand optimized type constraint with
one it creates internally.
.ie n .SS $constraint\->class
.el .SS \f(CW$constraint\fP\->class
.IX Subsection "$constraint->class"
Returns the class name associated with the constraint.
.ie n .SS $constraint\->parents
.el .SS \f(CW$constraint\fP\->parents
.IX Subsection "$constraint->parents"
Returns all the type's parent types, corresponding to its parent
classes.
.ie n .SS $constraint\->is_subtype_of($type_name_or_object)
.el .SS \f(CW$constraint\fP\->is_subtype_of($type_name_or_object)
.IX Subsection "$constraint->is_subtype_of($type_name_or_object)"
If the given type is also a class type, then this checks that the
type's class is a subclass of the other type's class.
.PP
Otherwise it falls back to the implementation in
Moose::Meta::TypeConstraint.
.ie n .SS $constraint\->create_child_type(%options)
.el .SS \f(CW$constraint\fP\->create_child_type(%options)
.IX Subsection "$constraint->create_child_type(%options)"
This returns a new Moose::Meta::TypeConstraint object with the type
as its parent.
.PP
Note that it does \fInot\fR return a
\&\f(CW\*(C`Moose::Meta::TypeConstraint::Class\*(C'\fR object!
.ie n .SS $constraint\->get_message($value)
.el .SS \f(CW$constraint\fP\->get_message($value)
.IX Subsection "$constraint->get_message($value)"
This is the same as "get_message" in Moose::Meta::TypeConstraint except
that it explicitly says \f(CW\*(C`isa\*(C'\fR was checked. This is to help users deal
with accidentally autovivified type constraints.
.SH BUGS
.IX Header "BUGS"
See "BUGS" in Moose for details on reporting bugs.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
Stevan Little <stevan@cpan.org>
.IP \(bu 4
Dave Rolsky <autarch@urth.org>
.IP \(bu 4
Jesse Luehrs <doy@cpan.org>
.IP \(bu 4
Shawn M Moore <sartak@cpan.org>
.IP \(bu 4
יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
.IP \(bu 4
Karen Etheridge <ether@cpan.org>
.IP \(bu 4
Florian Ragwitz <rafl@debian.org>
.IP \(bu 4
Hans Dieter Pearcey <hdp@cpan.org>
.IP \(bu 4
Chris Prather <chris@prather.org>
.IP \(bu 4
Matt S Trout <mstrout@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2006 by Infinity Interactive, Inc.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.