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

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

our $VERSION = '0.01';

requires qw/
    at
    put
    exists 
    keys 
    values 
    kv
/;

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