# Generated by Pod::WikiDoc version 0.18

=pod


=for stopwords Initialize expandtab shiftround

=head1 NAME

Getopt::LL::DLList - A doubly linked list.

=head1 VERSION

This document describes Getopt::LL::DLList version 1.0.0

=head1 SYNOPSIS

=head1 DESCRIPTION

     use Getopt:LL::DLList qw(getoptions);
 
     my @array = qw(The quick brown fox jumps over the lazy dog);
 
     # Create a doubly linked list out of the array.
     my $dllist = Getopt::LL::DLList->new(\@array);
 
     my $printer = DLList::Traverser::Print->new( );
 
     # Run the print_node method in the DLList::Traverser::Print object
     # for every node in our linked list. 
     $dllist->traverse($printer, 'print_node');
 
     package DLList::Traverser::Print;
     sub new {
         return bless { }, shift;
     };
     sub print_node {
         my ($self, $node_data, $node, $nodes_so_far) = @_;
         print "Node #$nodes_so_far: $node_data\n";
     }

=head1 SUBROUTINESE<sol>METHODS

=head2 CONSTRUCTOR

=head3 {new(@from_array)

Create a doubly linked list out of the given array.

=head2 ATTRIBUTES

=head3 C<<< head >>>

=head3 C<<< set_head >>>

The head (also called top node or root node) of the doubly linked list.

=head2 INSTANCE METHODS

=head3 C<<< traverse($handler_object, $handler_method) >>>

Traverse the doubly linked list, and for each element in the list
run the $handler_method with the $handler_object.

=head3 C<<< delete_node($node) >>>

Delete a node from the list.
Returns the value of the node deleted.

=head2 PRIVATE INSTANCE METHODS

=head3 C<<< _init() >>>

Initialize the doubly linked list.

=head3 C<<< DEMOLISH() >>>

Run at destruction.

=head1 DIAGNOSTICS

=head1 CONFIGURATION AND ENVIRONMENT

This module requires no configuration file or environment variables.

=head1 DEPENDENCIES

=over

=item *

L<Class::Dot>

=back

=over

=item *

L<version>

=back

=head1 INCOMPATIBILITIES

None known.

=head1 BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to
CE<lt>bug-getopt-ll@rt.cpan.orgE<gt>, or through the web interface at
LE<lt>http:E<sol>E<sol>rt.cpan.orgE<gt>.

=head1 SEE ALSO

=head2 Getopt::LL::Node

=head2 Getopt::LL

=head1 AUTHOR

Ask Solem, CE<lt>E<lt> ask@0x61736b.net E<gt>E<gt>.

=head1 LICENSE AND COPYRIGHT

Copyright (c), 2007 Ask Solem CE<lt>E<lt> ask@0x61736b.net E<gt>E<gt>.

All rights reserved.

This library is free software; you can redistribute it andE<sol>or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.

=head1 DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE
SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
STATED IN WRITING THE COPYRIGHT HOLDERS ANDE<sol>OR OTHER PARTIES PROVIDE THE
SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE,
YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY ANDE<sol>OR REDISTRIBUTE THE
SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO
LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER
SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.



# Local Variables:
#   mode: cperl
#   cperl-indent-level: 4
#   fill-column: 78
# End:
# vim: expandtab tabstop=4 shiftwidth=4 shiftround
