.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "MooseX::Singleton 3pm" .TH MooseX::Singleton 3pm "2011-12-08" "perl v5.14.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" MooseX::Singleton \- turn your Moose class into a singleton .SH "VERSION" .IX Header "VERSION" version 0.29 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& package MyApp; \& use MooseX::Singleton; \& \& has env => ( \& is => \*(Aqrw\*(Aq, \& isa => \*(AqHashRef[Str]\*(Aq, \& default => sub { \e%ENV }, \& ); \& \& package main; \& \& delete MyApp\->env\->{PATH}; \& my $instance = MyApp\->instance; \& my $same = MyApp\->instance; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" A singleton is a class that has only one instance in an application. \&\f(CW\*(C`MooseX::Singleton\*(C'\fR lets you easily upgrade (or downgrade, as it were) your Moose class to a singleton. .PP All you should need to do to transform your class is to change \f(CW\*(C`use Moose\*(C'\fR to \&\f(CW\*(C`use MooseX::Singleton\*(C'\fR. This module uses metaclass roles to do its magic, so it should cooperate with most other \f(CW\*(C`MooseX\*(C'\fR modules. .SH "METHODS" .IX Header "METHODS" A singleton class will have the following additional methods: .SS "Singleton\->instance" .IX Subsection "Singleton->instance" This returns the singleton instance for the given package. This method does \&\fInot\fR accept any arguments. If the instance does not yet exist, it is created with its defaults values. This means that if your singleton requires arguments, calling \f(CW\*(C`instance\*(C'\fR will die if the object has not already been initialized. .SS "Singleton\->initialize(%args)" .IX Subsection "Singleton->initialize(%args)" This method can be called \fIonly once per class\fR. It explicitly initializes the singleton object with the given arguments. .SS "Singleton\->_clear_instance" .IX Subsection "Singleton->_clear_instance" This clears the existing singleton instance for the class. Obviously, this is meant for use only inside the class itself. .SS "Singleton\->new" .IX Subsection "Singleton->new" This method currently works like a hybrid of \f(CW\*(C`initialize\*(C'\fR and \&\f(CW\*(C`instance\*(C'\fR. However, calling \f(CW\*(C`new\*(C'\fR directly will probably be deprecated in a future release. Instead, call \f(CW\*(C`initialize\*(C'\fR or \f(CW\*(C`instance\*(C'\fR as appropriate. .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \&\f(CW\*(C`bug\-moosex\-singleton@rt.cpan.org\*(C'\fR, or through the web interface at . We will be notified, and then you'll automatically be notified of progress on your bug as we make changes. .SH "SOME CODE STOLEN FROM" .IX Header "SOME CODE STOLEN FROM" Anders Nor Berle .SH "AND PATCHES FROM" .IX Header "AND PATCHES FROM" Ricardo \s-1SIGNES\s0 .SH "AUTHOR" .IX Header "AUTHOR" Shawn M Moore .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2011 by Shawn M Moore. .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.