Docs for Moose::Meta::TypeCoercion::Union

[gitmo/Moose.git] / lib / Moose / Meta / TypeCoercion / Union.pm

diff --git a/lib/Moose/Meta/TypeCoercion/Union.pm b/lib/Moose/Meta/TypeCoercion/Union.pm
index 07c2a02..a3d349d 100644 (file)
--- a/lib/Moose/Meta/TypeCoercion/Union.pm
+++ b/lib/Moose/Meta/TypeCoercion/Union.pm
@@ -7,7 +7,7 @@ use metaclass;
 
 use Scalar::Util 'blessed';
 
-our $VERSION   = '0.62_02';
+our $VERSION   = '0.72';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -43,6 +43,7 @@ sub compile_type_coercion {
 sub has_coercion_for_type { 0 }
 
 sub add_type_coercions {
+    require Moose;
     Moose->throw_error("Cannot add additional type coercions to Union types");
 }
 
@@ -58,26 +59,25 @@ Moose::Meta::TypeCoercion::Union - The Moose Type Coercion metaclass for Unions
 
 =head1 DESCRIPTION
 
-For the most part, the only time you will ever encounter an 
-instance of this class is if you are doing some serious deep 
-introspection. This API should not be considered final, but 
-it is B<highly unlikely> that this will matter to a regular 
-Moose user.
-
-If you wish to use features at this depth, please come to the 
-#moose IRC channel on irc.perl.org and we can talk :)
-
+This is a subclass of L<Moose::Meta::TypeCoercion> that is used for
+L<Moose::Meta::TypeConstraint::Union> objects.
 =head1 METHODS
 
 =over 4
 
-=item B<meta>
+=item B<< $coercion->has_coercion_for_type >>
+
+This method always returns false.
+
+=item B<< $coercion->add_type_coercions >>
 
-=item B<compile_type_coercion>
+This method always throws an error. You cannot add coercions to a
+union type constraint.
 
-=item B<has_coercion_for_type>
+=item B<< $coercion->coerce($value) >>
 
-=item B<add_type_coercions>
+This method will coerce by trying the coercions for each type in the
+union.
 
 =back
 
@@ -93,7 +93,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>