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