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

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

our $VERSION = '0.01';

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