File Coverage

blib/lib/XAS/Factory.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

package XAS::Factory;

our $VERSION = '0.02';

use Badger::Factory::Class
  debug   => 0,
  version => $VERSION,
  item    => 'module',
  path    => 'XAS::Lib XAS::Lib::Modules',
  modules => {
    alert       => 'XAS::Lib::Modules::Alerts',
    email       => 'XAS::Lib::Modules::Email',
    environment => 'XAS::Lib::Modules::Environment',
    log         => 'XAS::Lib::Log',
    logger      => 'XAS::Lib::Log',
    lockmgr     => 'XAS::Lib::Lockmgr',
    pidfile     => 'XAS::Lib::Pidfile',
    spool       => 'XAS::Lib::Modules::Spool',
    spooler     => 'XAS::Lib::Modules::Spool',
  }
;

1;

__END__

=head1 NAME

XAS::Factory - A factory system for the XAS environment

=head1 SYNOPSIS

You can use this module in the following manner.

 use XAS::Factory;

 my $env = XAS::Factory->module('environment');

 ... or ...

 my $env = XAS:Factory->module('Environment');

Either of the above statements will load the L<XAS::Lib::Modules::Environment|XAS::Lib::Modules::Environment> module.

=head1 DESCRIPTION

This module is a factory system for the XAS environment. It will load and
initialize modules on demand. The advantage is that you don't need to load
all your modules at the beginning of your program. You also don't need to
know where individual modules live. And this system can provide nice alias
for long module names. This should lead to cleaner more readable programs.

=head1 MODULES

The following modules have been defined.

=over 4

=item B<alert>

This will load L<XAS::Lib::Modules::Alerts|XAS::Lib::Modules::Alerts>.

=item B<email>

This will load L<XAS::Lib::Modules::Email|XAS::Lib::Modules::Email>.

=item B<environment>

This will load L<XAS::Lib::Modules::Environment|XAS::Lib::Modules::Environment>

=item B<log logger>

This will load L<XAS::Lib::Log|XAS::Lib::Log>

=item B<locking lockmgr>

This will load L<XAS::Lib::Lockmgr|XAS::Lib::Lockmgr>.

=item B<pidfile>

This will load L<XAS::Lib::Pidfile|XAS::Lib::Pidfile>.

=item B<spool spooler>

This will load L<XAS::Lib::Modules::Spool|XAS::Lib::Modules::Spool>.

=back

=head1 METHODS

=head2 module

This method loads the named module and passes any parameters to that module.

=head1 SEE ALSO

=over 4

=item L<XAS|XAS>

=back

=head1 AUTHOR

Kevin L. Esteb, E<lt>[e-mail]<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (c) 2012-2015 Kevin L. Esteb

This is free software; you can redistribute it and/or modify it under
the terms of the Artistic License 2.0. For details, see the full text
of the license at http://www.perlfoundation.org/artistic_license_2_0.

=cut