package Catalyst::DispatchType;
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose; # using it to add Moose::Object to @ISA ...
+no Moose;
=head1 NAME
=head1 DESCRIPTION
+This is an abstract base class for Dispatch Types.
+
=head1 METHODS
-=over 4
+=head2 $self->list($c)
-=item $self->list($c)
+abstract method, to be implemented by dispatchtypes. Called to display
+info in debug log.
=cut
sub list { }
-=item $self->match( $c, $path )
+=head2 $self->match( $c, $path )
+
+abstract method, to be implemented by dispatchtypes. Returns true if the
+dispatch type matches the given path
=cut
sub match { die "Abstract method!" }
-=item $self->register( $c, $action )
+=head2 $self->register( $c, $action )
+
+abstract method, to be implemented by dispatchtypes. Takes a
+context object and a L<Catalyst::Action> object.
+
+Should return true if it registers something, or false otherwise.
=cut
sub register { }
-=back
+=head2 $self->uri_for_action( $action, \@captures )
+
+abstract method, to be implemented by dispatchtypes. Takes a
+L<Catalyst::Action> object and an arrayref of captures, and should
+return either a URI part which if placed in $c->req->path would cause
+$self->match to match this action and set $c->req->captures to the supplied
+arrayref, or undef if unable to do so.
+
+=cut
+
+sub uri_for_action { }
+
+=head2 $self->expand_action
-=head1 AUTHOR
+Default fallback, returns nothing. See L<Catalyst::Dispatcher> for more info
+about expand_action.
+
+=cut
-Matt S Trout
-Sebastian Riedel, C<sri@cpan.org>
+sub expand_action { }
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
=cut
+__PACKAGE__->meta->make_immutable;
+
1;