c54fe0f9d83cbfce01d3725a6dea577736664651
[gitmo/MooseX-Getopt.git] / lib / MooseX / Getopt / Meta / Attribute / Trait / NoGetopt.pm
1
2 package MooseX::Getopt::Meta::Attribute::Trait::NoGetopt;
3 use Moose::Role;
4
5 our $VERSION   = '0.25';
6 our $AUTHORITY = 'cpan:STEVAN';
7
8 no Moose::Role;
9
10 # register this as a metaclass alias ...
11 package # stop confusing PAUSE
12     Moose::Meta::Attribute::Custom::Trait::NoGetopt;
13 sub register_implementation { 'MooseX::Getopt::Meta::Attribute::Trait::NoGetopt' }
14
15 1;
16
17 __END__
18
19 =pod
20
21 =head1 NAME
22
23 MooseX::Getopt::Meta::Attribute::Trait::NoGetopt - Optional meta attribute trait for ignoring params
24
25 =head1 SYNOPSIS
26
27   package App;
28   use Moose;
29   
30   with 'MooseX::Getopt';
31   
32   has 'data' => (
33       traits  => [ 'NoGetopt' ],  # do not attempt to capture this param  
34       is      => 'ro',
35       isa     => 'Str',
36       default => 'file.dat',
37   );
38
39 =head1 DESCRIPTION
40
41 This is a custom attribute metaclass trait which can be used to 
42 specify that a specific attribute should B<not> be processed by 
43 C<MooseX::Getopt>. All you need to do is specify the C<NoGetopt> 
44 metaclass trait.
45
46   has 'foo' => (traits => [ 'NoGetopt', ... ], ... );
47
48 =head1 METHODS
49
50 =over 4
51
52 =item B<meta>
53
54 =back
55
56 =head1 BUGS
57
58 All complex software has bugs lurking in it, and this module is no 
59 exception. If you find a bug please either email me, or add the bug
60 to cpan-RT.
61
62 =head1 AUTHOR
63
64 Stevan Little E<lt>stevan@iinteractive.comE<gt>
65
66 =head1 COPYRIGHT AND LICENSE
67
68 Copyright 2007-2008 by Infinity Interactive, Inc.
69
70 L<http://www.iinteractive.com>
71
72 This library is free software; you can redistribute it and/or modify
73 it under the same terms as Perl itself.
74
75 =cut