lib/MooseX/AttributeHelpers/Collection/ImmutableHash.pm

   1
   2 package MooseX::AttributeHelpers::Collection::ImmutableHash;
   3 use Moose;
   4
   5 our $VERSION   = '0.12_01';
   6 $VERSION = eval $VERSION;
   7 our $AUTHORITY = 'cpan:STEVAN';
   8
   9 use MooseX::AttributeHelpers::MethodProvider::ImmutableHash;
  10
  11 extends 'MooseX::AttributeHelpers::Collection';
  12
  13 has '+method_provider' => (
  14     default => 'MooseX::AttributeHelpers::MethodProvider::ImmutableHash'
  15 );
  16
  17 sub helper_type { 'HashRef' }
  18
  19 no Moose;
  20
  21 # register the alias ...
  22 package # hide me from search.cpan.org
  23     Moose::Meta::Attribute::Custom::Collection::ImmutableHash;
  24 sub register_implementation { 'MooseX::AttributeHelpers::Collection::ImmutableHash' }
  25
  26
  27 1;
  28
  29 __END__
  30
  31 =pod
  32
  33 =head1 NAME
  34
  35 MooseX::AttributeHelpers::Collection::ImmutableHash
  36
  37 =head1 SYNOPSIS
  38
  39   package Stuff;
  40   use Moose;
  41   use MooseX::AttributeHelpers;
  42
  43   has 'options' => (
  44       metaclass => 'Collection::ImmutableHash',
  45       is        => 'ro',
  46       isa       => 'HashRef[Str]',
  47       default   => sub { {} },
  48       provides  => {
  49           'get'    => 'get_option',
  50           'empty'  => 'has_options',
  51           'keys'   => 'get_option_list',
  52       }
  53   );
  54
  55 =head1 DESCRIPTION
  56
  57 This module provides a immutable HashRef attribute which provides a number of
  58 hash-line operations. See L<MooseX::AttributeHelpers::MethodProvider::ImmutableHash>
  59 for more details.
  60
  61 =head1 METHODS
  62
  63 =over 4
  64
  65 =item B<meta>
  66
  67 =item B<method_provider>
  68
  69 =item B<has_method_provider>
  70
  71 =item B<helper_type>
  72
  73 =back
  74
  75 =head1 BUGS
  76
  77 All complex software has bugs lurking in it, and this module is no
  78 exception. If you find a bug please either email me, or add the bug
  79 to cpan-RT.
  80
  81 =head1 AUTHOR
  82
  83 Stevan Little E<lt>stevan@iinteractive.comE<gt>
  84
  85 =head1 COPYRIGHT AND LICENSE
  86
  87 Copyright 2007-2008 by Infinity Interactive, Inc.
  88
  89 L<http://www.iinteractive.com>
  90
  91 This library is free software; you can redistribute it and/or modify
  92 it under the same terms as Perl itself.
  93
  94 =cut