/ 
Module-Format-v0.0.2
River stage one • 1 direct dependent • 1 total dependent
/ Module::Format::ModuleList

NAME

Module::Format::ModuleList - an ordered list of Module::Format::Module.

VERSION

Version 0.0.2

SYNOPSIS

use Module::Format::ModuleList;

my $list = Module::Format::ModuleList->new(
    {
        modules =>
        [
            Module::Format::Module->from_guess({ value => 'XML::RSS'}),
            Module::Format::Module->from_guess({ value => 'Data-Dumper'}),
        ],
    }
);

foreach my $name (@{$list->format_as('rpm_colon')})
{
    print "$name\n";    
}

my $list = Module::Format::ModuleList->sane_from_guesses(
    {
        values =>
        [qw/
            Algorithm::Permutations
            rpm(Foo::Bar::Baz)
            perl-HTML-TreeBuilder-LibXML
        /],
    },
)

FUNCTIONS

my $list = Module::Format::ModuleList->new({ modules => \@list})

The generic constructor. Initialises a new module list from a @list which must be an array of Module::Format::Module modules.

my $array_ref = $self->get_modules_list_copy()

Returns a shallow copy of the modules list contained in the object. Useful for debugging.

my $array_ref_of_strings = $list->format_as($format)

Returns a list containing all the modules formatted in the $format . See Module::Format::Module for the available formats.

my $list_obj = Module::Format::ModuleList->sane_from_guesses({values => \@list_of_strings});

Initialises a module list object from a list of strings by using Module::Format::Module's from_guess on each string and while checking the guesses for sanity. See the synposis for an example.

AUTHOR

Shlomi Fish, http://www.shlomifish.org/

BUGS

Please report any bugs or feature requests to bug-module-format at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Module-Format. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Module::Format::ModuleList

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2010 Shlomi Fish.

This program is distributed under the MIT (X11) License: http://www.opensource.org/licenses/mit-license.php

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.