ba2923284eea953fb09d9c4b9a7f3139c6812854
[gitmo/MooseX-AttributeHelpers.git] / lib / MooseX / AttributeHelpers / Collection / ImmutableHash.pm
1
2 package MooseX::AttributeHelpers::Collection::ImmutableHash;
3 use Moose;
4
5 our $VERSION   = '0.19';
6 $VERSION = eval $VERSION;
7 our $AUTHORITY = 'cpan:STEVAN';
8
9 extends 'Moose::Meta::Attribute';
10 with 'MooseX::AttributeHelpers::Trait::Collection::ImmutableHash';
11
12 no Moose;
13
14 # register the alias ...
15 package # hide me from search.cpan.org
16     Moose::Meta::Attribute::Custom::Collection::ImmutableHash;
17 sub register_implementation { 'MooseX::AttributeHelpers::Collection::ImmutableHash' }
18
19
20 1;
21
22 __END__
23
24 =pod
25
26 =head1 NAME
27
28 MooseX::AttributeHelpers::Collection::ImmutableHash
29
30 =head1 SYNOPSIS
31
32   package Stuff;
33   use Moose;
34   use MooseX::AttributeHelpers;
35   
36   has 'options' => (
37       metaclass => 'Collection::ImmutableHash',
38       is        => 'ro',
39       isa       => 'HashRef[Str]',
40       default   => sub { {} },
41       provides  => {
42           'get'    => 'get_option',            
43           'empty'  => 'has_options',
44           'keys'   => 'get_option_list',
45       }
46   );
47   
48 =head1 DESCRIPTION
49
50 This module provides a immutable HashRef attribute which provides a number of 
51 hash-line operations. See L<MooseX::AttributeHelpers::MethodProvider::ImmutableHash>
52 for more details.
53
54 =head1 METHODS
55
56 =over 4
57
58 =item B<meta>
59
60 =item B<method_provider>
61
62 =item B<has_method_provider>
63
64 =item B<helper_type>
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 2007-2009 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