5efd461694b196795877f29a5c83e2db0627bae9
[gitmo/Moose-Autobox.git] / lib / Moose / Autobox / Indexed.pm
1 package Moose::Autobox::Indexed;     
2 use Moose::Role 'requires';
3
4 our $VERSION = '0.02';
5
6 requires 'at';
7 requires 'put';
8 requires 'exists'; 
9 requires 'keys';
10 requires 'values'; 
11 requires 'kv';
12 requires 'slice';
13
14 1;
15
16 __END__
17
18 =pod
19
20 =head1 NAME 
21
22 Moose::Autobox::Indexed - the Indexed role
23
24 =head1 DESCRIPTION
25
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
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
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
71 Copyright 2006-2008 by Infinity Interactive, Inc.
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
78 =cut