[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 SYNOPOSIS

  use Moose::Autobox;
  use autobox;

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