[gitmo/Moose-Autobox.git] / lib / Moose / Autobox / Indexed.pm

package Moose::Autobox::Indexed;     
use Moose::Role 'requires';

our $VERSION = '0.09';

requires 'at';
requires 'put';
requires 'exists'; 
requires 'keys';
requires 'values'; 
requires 'kv';
requires 'slice';

1;

__END__

=pod

=head1 NAME 

Moose::Autobox::Indexed - the Indexed role

=head1 DESCRIPTION

This is a role to describes an collection whose values can be 
accessed by a key of some kind. 

The role is entirely abstract, those which implement it must 
supply all it's methods. Currently both L<Moose::Autobox::Array>
and L<Moose::Autobox::Hash> implement this role.

=head1 METHODS

=over 4

=item B<meta>

=back

=head1 REQUIRED METHODS

=over 4

=item B<at>

=item B<put>

=item B<exists>

=item B<keys>

=item B<values>

=item B<kv>

=back

=head1 BUGS

All complex software has bugs lurking in it, and this module is no 
exception. If you find a bug please either email me, or add the bug
to cpan-RT.

=head1 AUTHOR

Stevan Little E<lt>stevan@iinteractive.comE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright 2006-2008 by Infinity Interactive, Inc.

L<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut
Commit	Line	Data
6cf5bcf2	1	package Moose::Autobox::Indexed;
	2	use Moose::Role 'requires';
	3
caac33a3	4	our $VERSION = '0.09';
6cf5bcf2	5
680d0745	6	requires 'at';
	7	requires 'put';
	8	requires 'exists';
	9	requires 'keys';
	10	requires 'values';
	11	requires 'kv';
18ef6e1c	12	requires 'slice';
6cf5bcf2	13
31d40d73	14	1;
	15
	16	__END__
	17
	18	=pod
	19
	20	=head1 NAME
	21
	22	Moose::Autobox::Indexed - the Indexed role
	23
31d40d73	24	=head1 DESCRIPTION
31d40d73	25
8937074a	26	This is a role to describes an collection whose values can be
	27	accessed by a key of some kind.
	28
	29	The role is entirely abstract, those which implement it must
	30	supply all it's methods. Currently both L<Moose::Autobox::Array>
	31	and L<Moose::Autobox::Hash> implement this role.
	32
260cc81f	33	=head1 METHODS
	34
	35	=over 4
	36
	37	=item B<meta>
	38
	39	=back
	40
	41	=head1 REQUIRED METHODS
	42
	43	=over 4
	44
	45	=item B<at>
	46
	47	=item B<put>
	48
	49	=item B<exists>
	50
	51	=item B<keys>
	52
	53	=item B<values>
	54
	55	=item B<kv>
	56
	57	=back
	58
31d40d73	59	=head1 BUGS
	60
	61	All complex software has bugs lurking in it, and this module is no
	62	exception. If you find a bug please either email me, or add the bug
	63	to cpan-RT.
	64
	65	=head1 AUTHOR
	66
	67	Stevan Little E<lt>stevan@iinteractive.comE<gt>
	68
	69	=head1 COPYRIGHT AND LICENSE
	70
ea4e64bf	71	Copyright 2006-2008 by Infinity Interactive, Inc.
31d40d73	72
	73	L<http://www.iinteractive.com>
	74
	75	This library is free software; you can redistribute it and/or modify
	76	it under the same terms as Perl itself.
	77
18ef6e1c	78	=cut