.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Class::Meta::Constructor 3pm"
.TH Class::Meta::Constructor 3pm "2022-06-11" "perl v5.34.0" "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"
Class::Meta::Constructor \- Class::Meta class constructor introspection
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  # Assuming MyApp::Thingy was generated by Class::Meta.
\&  my $class = MyApp::Thingy\->my_class;
\&
\&  print "\enConstructors:\en";
\&  for my $ctor ($class\->constructors) {
\&      print "  o ", $ctor\->name, $/;
\&      my $thingy = $ctor\->call($class\->package);
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides an interface to the \f(CW\*(C`Class::Meta\*(C'\fR objects that describe
class constructors. It supports a simple description of the constructor, a
label, and the constructor visibility (private, protected, trusted,or public).
.PP
Class::Meta::Constructor objects are created by Class::Meta; they are never
instantiated directly in client code. To access the constructor objects for a
Class::Meta\-generated class, simply call its \f(CW\*(C`my_class()\*(C'\fR method to retrieve
its Class::Meta::Class object, and then call the \f(CW\*(C`constructors()\*(C'\fR method on
the Class::Meta::Class object.
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "Constructors"
.IX Subsection "Constructors"
\fInew\fR
.IX Subsection "new"
.PP
A protected method for constructing a Class::Meta::Constructor object. Do not
call this method directly; Call the
\&\f(CW\*(C`add_constructor()\*(C'\fR method on a Class::Meta
object, instead.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fIname\fR
.IX Subsection "name"
.PP
.Vb 1
\&  my $name = $ctor\->name;
.Ve
.PP
Returns the constructor name.
.PP
\fIpackage\fR
.IX Subsection "package"
.PP
.Vb 1
\&  my $package = $ctor\->package;
.Ve
.PP
Returns the package name of the class that constructor is associated with.
.PP
\fIdesc\fR
.IX Subsection "desc"
.PP
.Vb 1
\&  my $desc = $ctor\->desc;
.Ve
.PP
Returns the description of the constructor.
.PP
\fIlabel\fR
.IX Subsection "label"
.PP
.Vb 1
\&  my $desc = $ctor\->label;
.Ve
.PP
Returns label for the constructor.
.PP
\fIview\fR
.IX Subsection "view"
.PP
.Vb 1
\&  my $view = $ctor\->view;
.Ve
.PP
Returns the view of the constructor, reflecting its visibility. The possible
values are defined by the following constants:
.IP "Class::Meta::PUBLIC" 4
.IX Item "Class::Meta::PUBLIC"
.PD 0
.IP "Class::Meta::PRIVATE" 4
.IX Item "Class::Meta::PRIVATE"
.IP "Class::Meta::TRUSTED" 4
.IX Item "Class::Meta::TRUSTED"
.IP "Class::Meta::PROTECTED" 4
.IX Item "Class::Meta::PROTECTED"
.PD
.PP
\fIclass\fR
.IX Subsection "class"
.PP
.Vb 1
\&  my $class = $ctor\->class;
.Ve
.PP
Returns the Class::Meta::Class object that this constructor is associated
with. Note that this object will always represent the class in which the
constructor is defined, and \fInot\fR any of its subclasses.
.PP
\fIcall\fR
.IX Subsection "call"
.PP
.Vb 1
\&  my $obj = $ctor\->call($package, @params);
.Ve
.PP
Executes the constructor. Pass in the name of the class for which it is being
executed (since, thanks to subclassing, it may be different than the class
with which the constructor is associated). All other parameters will be passed
to the constructor. Note that it uses a \f(CW\*(C`goto\*(C'\fR to execute the constructor, so
the call to \f(CW\*(C`call()\*(C'\fR itself will not appear in a call stack trace.
.PP
\fIbuild\fR
.IX Subsection "build"
.PP
.Vb 1
\&  $ctor\->build($class);
.Ve
.PP
This is a protected method, designed to be called only by the Class::Meta
class or a subclass of Class::Meta. It takes a single argument, the
Class::Meta::Class object for the class in which the constructor was defined,
and generates constructor method for the Class::Meta::Constructor, either by
installing the code reference passed in the \f(CW\*(C`code\*(C'\fR parameter or by creating
the constructor from scratch.
.PP
Although you should never call this method directly, subclasses of
Class::Meta::Constructor may need to override its behavior.
.SH "BUGS"
.IX Header "BUGS"
Please send bug reports to <bug\-class\-meta@rt.cpan.org> or report them via the
\&\s-1CPAN\s0 Request Tracker at <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Class\-Meta>.
.SH "SUPPORT"
.IX Header "SUPPORT"
This module is stored in an open GitHub
repository <http://github.com/theory/class-meta/>. Feel free to fork and
contribute!
.PP
Please file bug reports via GitHub
Issues <http://github.com/theory/class-meta/issues/> or by sending mail to
bug\-Class\-Meta@rt.cpan.org <mailto:bug-Class-Meta@rt.cpan.org>.
.SH "AUTHOR"
.IX Header "AUTHOR"
David E. Wheeler <david@justatheory.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Other classes of interest within the Class::Meta distribution include:
.IP "Class::Meta" 4
.IX Item "Class::Meta"
.PD 0
.IP "Class::Meta::Class" 4
.IX Item "Class::Meta::Class"
.IP "Class::Meta::Method" 4
.IX Item "Class::Meta::Method"
.IP "Class::Meta::Attribute" 4
.IX Item "Class::Meta::Attribute"
.PD
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2002\-2011, David E. Wheeler. Some Rights Reserved.
.PP
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.