.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Bread::Board::LifeCycle::Singleton::WithParameters 3pm"
.TH Bread::Board::LifeCycle::Singleton::WithParameters 3pm "2020-04-01" "perl v5.30.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"
Bread::Board::LifeCycle::Singleton::WithParameters \- singleton lifecycle role for a parameterized service
.SH "VERSION"
.IX Header "VERSION"
version 0.37
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sub-role of Bread::Board::LifeCycle, this role defines the
\&\*(L"singleton\*(R" lifecycle for a parameterized service. The \f(CW\*(C`get\*(C'\fR method
will only do its work the first time it is invoked for each set of
parameters; subsequent invocations with the same parameters will
return the same object.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS """instances"""
.el .SS "\f(CWinstances\fP"
.IX Subsection "instances"
Hashref mapping keys to objects, used to cache the results of \*(L"get\*(R"
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """get"""
.el .SS "\f(CWget\fP"
.IX Subsection "get"
Generates a key using \*(L"generate_instance_key\*(R" (passing it all the
arguments); if the \*(L"instances\*(R" attribute does not hold an object for
that key, it will build it (by calling the underlying \f(CW\*(C`get\*(C'\fR method)
and store it in \*(L"instances\*(R". The object (either retrieved from
\&\*(L"instances\*(R" or freshly built) will be returned.
.ie n .SS """generate_instance_key"""
.el .SS "\f(CWgenerate_instance_key\fP"
.IX Subsection "generate_instance_key"
Generates a (hopefully) unique key from the given arguments (usually,
whatever was passed to \*(L"get\*(R"). The current implementation
stringifies all arguments, so different references to identical values
will be considered different.
.SH "AUTHOR"
.IX Header "AUTHOR"
Stevan Little <stevan@iinteractive.com>
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
https://github.com/stevan/BreadBoard/issues
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2019, 2017, 2016, 2015, 2014, 2013, 2011, 2009 by Infinity Interactive.
.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.