lib/Moose/Autobox/Indexed.pm

   1 package Moose::Autobox::Indexed;
   2 use Moose::Role 'requires';
   3
   4 our $VERSION = '0.12';
   5
   6 requires 'at';
   7 requires 'put';
   8 requires 'exists';
   9 requires 'keys';
  10 requires 'values';
  11 requires 'kv';
  12 requires 'slice';
  13 requires qw(each each_key each_value each_n_values);
  14
  15 1;
  16
  17 __END__
  18
  19 =pod
  20
  21 =head1 NAME
  22
  23 Moose::Autobox::Indexed - the Indexed role
  24
  25 =head1 DESCRIPTION
  26
  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
  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 =item B<slice>
  59
  60 =item B<each>
  61
  62 =item B<each_key>
  63
  64 =item B<each_value>
  65
  66 =back
  67
  68 =head1 BUGS
  69
  70 All complex software has bugs lurking in it, and this module is no
  71 exception. If you find a bug please either email me, or add the bug
  72 to cpan-RT.
  73
  74 =head1 AUTHOR
  75
  76 Stevan Little E<lt>stevan@iinteractive.comE<gt>
  77
  78 =head1 COPYRIGHT AND LICENSE
  79
  80 Copyright 2006-2008 by Infinity Interactive, Inc.
  81
  82 L<http://www.iinteractive.com>
  83
  84 This library is free software; you can redistribute it and/or modify
  85 it under the same terms as Perl itself.
  86
  87 =cut