# You may distribute under the terms of either the GNU General Public License
# or the Artistic License (the same terms as Perl itself)
#
# (C) Paul Evans, 2011-2012 -- leonerd@leonerd.org.uk
package Tangence::Meta::Method;
use strict;
use warnings;
our $VERSION = '0.16';
use Scalar::Util qw( weaken );
=head1 NAME
C<Tangence::Meta::Method> - structure representing one C<Tangence> method
=head1 DESCRIPTION
This data structure object stores information about one L<Tangence> class
method. Once constructed, such objects are immutable.
=cut
=head1 CONSTRUCTOR
=cut
=head2 $method = Tangence::Meta::Method->new( %args )
Returns a new instance initialised by the given arguments.
=over 8
=item class => Tangence::Meta::Class
Reference to the containing class
=item name => STRING
Name of the method
=item arguments => ARRAY
Optional ARRAY reference containing arguments as
L<Tangence::Meta::Argument> references.
=item ret => STRING
Optional string giving the return value type as a L<Tangence::Meta::Type>
reference
=back
=cut
sub new
{
my $class = shift;
my %args = @_;
$args{arguments} ||= [];
my $self = bless \%args, $class;
weaken $self->{class};
return $self;
}
=head1 ACCESSORS
=cut
=head2 $class = $method->class
Returns the class the method is a member of
=cut
sub class
{
my $self = shift;
return $self->{class};
}
=head2 $name = $method->name
Returns the name of the class
=cut
sub name
{
my $self = shift;
return $self->{name};
}
=head2 @arguments = $method->arguments
Return the arguments in a list of L<Tangence::Meta::Argument> references.
=cut
sub arguments
{
my $self = shift;
return @{ $self->{arguments} };
}
=head2 @argtypes = $method->argtypes
Return the argument types in a list of L<Tangence::Meta::Type> references.
=cut
sub argtypes
{
my $self = shift;
return map { $_->type } $self->arguments;
}
=head2 $ret = $method->ret
Returns the return type as a L<Tangence::Meta::Type> reference or C<undef> if
the method does not return a value.
=cut
sub ret
{
my $self = shift;
return $self->{ret};
}
=head1 AUTHOR
Paul Evans <leonerd@leonerd.org.uk>
=cut
0x55AA;