NAME

Moose::Meta::TypeConstraint::Enum - Type constraint for enumerated values.

VERSION

version 2.2201

DESCRIPTION

This class represents type constraints based on an enumerated list of acceptable values.

INHERITANCE

"Moose::Meta::TypeConstraint::Enum" is a subclass of Moose::Meta::TypeConstraint.

METHODS

Moose::Meta::TypeConstraint::Enum->new(%options)

This creates a new enum type constraint based on the given %options.

It takes the same options as its parent, with several exceptions. First, it requires an additional option, "values". This should be an array reference containing a list of valid string values. Second, it automatically sets the parent to the "Str" type.

Finally, it ignores any provided "constraint" option. The constraint is generated automatically based on the provided "values".

$constraint->values

Returns the array reference of acceptable values provided to the constructor.

$constraint->create_child_type

This returns a new Moose::Meta::TypeConstraint object with the type as its parent.

Note that it does not return a "Moose::Meta::TypeConstraint::Enum" object!

BUGS

See "BUGS" in Moose for details on reporting bugs.

AUTHORS

Stevan Little <stevan@cpan.org>
Dave Rolsky <autarch@urth.org>
Jesse Luehrs <doy@cpan.org>
Shawn M Moore <sartak@cpan.org>
יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
Karen Etheridge <ether@cpan.org>
Florian Ragwitz <rafl@debian.org>
Hans Dieter Pearcey <hdp@cpan.org>
Chris Prather <chris@prather.org>
Matt S Trout <mstrout@cpan.org>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.