.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MooseX::Types::VariantTable 3pm"
.TH MooseX::Types::VariantTable 3pm "2011-02-27" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MooseX::Types::VariantTable \- Type constraint based variant table
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # see also MooseX::Types::VariantTable::Declare for a way to
\&    # declare variant table based methods
\&
\&        use MooseX::Types::VariantTable;
\&
\&    my $dispatch_table = MooseX::Types::VariantTable\->new(
\&        variants => [
\&            { type => "Foo", value => \e&foo_handler },
\&            { type => "Bar", value => \e&bar_handler },
\&            { type => "Item", value => \e&fallback },
\&        ],
\&    );
\&
\&    # look up the correct handler for $thingy based on the type constraints it passes
\&    my $entry = $dispatch_table\->find_variant($thingy);
\&
\&    # or use the \*(Aqdispatch\*(Aq convenience method if the entries are code refs
\&    $dispatch_table\->dispatch( $thingy, @args );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object implements a simple dispatch table based on Moose type constraints.
.PP
Subtypes will be checked before their parents, meaning that the order of the
declaration does not matter.
.PP
This object is used internally by Moose::Meta::Method::VariantTable and
MooseX::Types::VariantTable::Declare to provide primitive multi
sub support.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "ambigious_match_callback"
.IX Subsection "ambigious_match_callback"
A code reference that'll be executed when find_variant found more than one
matching variant for a value. It defaults to something that simply croaks with
an error message like this:
.PP
.Vb 1
\&  Ambiguous match %s
.Ve
.PP
where \f(CW%s\fR contains a list of stringified types that matched.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
.PD 0
.ie n .IP "add_variant $type, $value" 4
.el .IP "add_variant \f(CW$type\fR, \f(CW$value\fR" 4
.IX Item "add_variant $type, $value"
.PD
Registers \f(CW$type\fR, such that \f(CW$value\fR will be returned by \f(CW\*(C`find_variant\*(C'\fR for
items passing \f(CW$type\fR.
.Sp
Subtyping is respected in the table.
.ie n .IP "find_variant $value" 4
.el .IP "find_variant \f(CW$value\fR" 4
.IX Item "find_variant $value"
Returns the registered value for the most specific type that \f(CW$value\fR passes.
.ie n .IP "dispatch $value, @args" 4
.el .IP "dispatch \f(CW$value\fR, \f(CW@args\fR" 4
.IX Item "dispatch $value, @args"
A convenience method for when the registered values are code references.
.Sp
Calls \f(CW\*(C`find_variant\*(C'\fR and if the result is a code reference, it will \f(CW\*(C`goto\*(C'\fR
this code reference with the value and any additional arguments.
.ie n .IP "has_type $type" 4
.el .IP "has_type \f(CW$type\fR" 4
.IX Item "has_type $type"
Returns true if an entry for \f(CW$type\fR is registered.
.ie n .IP "has_parent $type" 4
.el .IP "has_parent \f(CW$type\fR" 4
.IX Item "has_parent $type"
Returns true if a parent type of \f(CW$type\fR is registered.
.SH "TODO"
.IX Header "TODO"
The meta method composes in multiple inheritence but not yet with roles due to
extensibility issues with the role application code.
.PP
When Moose::Meta::Role can pluggably merge methods variant table methods can
gain role composition.
.SH "AUTHOR"
.IX Header "AUTHOR"
Yuval Kogman <nothingmuch@woobling.org>
.PP
Florian Ragwitz <rafl@debian.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 3
\&        Copyright (c) 2008 Yuval Kogman. All rights reserved
\&        This program is free software; you can redistribute
\&        it and/or modify it under the same terms as Perl itself.
.Ve