NAME¶
MooseX::Singleton - turn your Moose class into a singleton
VERSION¶
version 0.29
SYNOPSIS¶
package MyApp;
use MooseX::Singleton;
has env => (
is => 'rw',
isa => 'HashRef[Str]',
default => sub { \%ENV },
);
package main;
delete MyApp->env->{PATH};
my $instance = MyApp->instance;
my $same = MyApp->instance;
DESCRIPTION¶
A singleton is a class that has only one instance in an application.
"MooseX::Singleton" lets you easily upgrade (or downgrade, as it
were) your Moose class to a singleton.
All you should need to do to transform your class is to change "use
Moose" to "use MooseX::Singleton". This module uses metaclass
roles to do its magic, so it should cooperate with most other
"MooseX" modules.
METHODS¶
A singleton class will have the following additional methods:
Singleton->instance¶
This returns the singleton instance for the given package. This method does
not 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 "instance" will die if the object has not already
been initialized.
Singleton->initialize(%args)¶
This method can be called
only once per class. It explicitly initializes
the singleton object with the given arguments.
Singleton->_clear_instance¶
This clears the existing singleton instance for the class. Obviously, this is
meant for use only inside the class itself.
Singleton->new¶
This method currently works like a hybrid of "initialize" and
"instance". However, calling "new" directly will probably
be deprecated in a future release. Instead, call "initialize" or
"instance" as appropriate.
BUGS¶
Please report any bugs or feature requests to
"bug-moosex-singleton@rt.cpan.org", or through the web interface at
<
http://rt.cpan.org>. We will be notified, and then you'll automatically
be notified of progress on your bug as we make changes.
SOME CODE STOLEN FROM¶
Anders Nor Berle <debolaz@gmail.com>
AND PATCHES FROM¶
Ricardo SIGNES <rjbs@cpan.org>
AUTHOR¶
Shawn M Moore <sartak@gmail.com>
COPYRIGHT AND LICENSE¶
This software is copyright (c) 2011 by Shawn M Moore.
This is free software; you can redistribute it and/or modify it under the same
terms as the Perl 5 programming language system itself.