PerlBean::Method - contains bean method information
TODO
Abstract PerlBean method information
PerlBean::Method class for bean method information.
PerlBean::Method
Creates a new PerlBean::Method object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.
OPT_HASH_REF
Error::Simple
Options for OPT_HASH_REF may include:
body
Passed to set_body().
description
Passed to set_description().
documented
Passed to set_documented(). Defaults to 1.
exception_class
Passed to set_exception_class(). Defaults to 'Error::Simple'.
implemented
Passed to set_implemented(). Defaults to 1.
interface
Passed to set_interface().
method_name
Passed to set_method_name(). Mandatory option.
parameter_description
Passed to set_parameter_description().
perl_bean
Passed to set_perl_bean().
volatile
Passed to set_volatile().
Returns the method's body.
Returns the method description.
Returns the class to throw in eventual interface implementations.
Returns the method's name.
Returns the package name. The package name is obtained from the PerlBean to which the PerlBean::Attribute belongs. Or, if the PerlBean::Attribute does not belong to a PerlBean, main is returned.
PerlBean
PerlBean::Attribute
main
Returns the parameter description.
Returns the PerlBean to which this method belongs.
Returns whether the method is documented or not.
Returns whether the method is implemented or not.
Returns whether the method is defined as interface or not.
Returns whether the method is volatile or not.
Set the method's body. VALUE is the value. On error an exception Error::Simple is thrown.
VALUE
Set the method description. VALUE is the value. On error an exception Error::Simple is thrown.
State that the method is documented. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.
1
Set the class to throw in eventual interface implementations. VALUE is the value. Default value at initialization is Error::Simple. VALUE may not be undef. On error an exception Error::Simple is thrown.
undef
State that the method is implemented. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.
State that the method is defined as interface. VALUE is the value. On error an exception Error::Simple is thrown.
Set the method's name. VALUE is the value. VALUE may not be undef. On error an exception Error::Simple is thrown.
Set the parameter description. VALUE is the value. On error an exception Error::Simple is thrown.
Set the PerlBean to which this method belongs. VALUE is the value. On error an exception Error::Simple is thrown.
State that the method is volatile. VALUE is the value. On error an exception Error::Simple is thrown.
Write the code for the method to FILEHANDLE. FILEHANDLE is an IO::Handle object. On error an exception Error::Simple is thrown.
FILEHANDLE
IO::Handle
Write the documentation for the method to FILEHANDLE. FILEHANDLE is an IO::Handle object. On error an exception Error::Simple is thrown.
PerlBean, PerlBean::Attribute, PerlBean::Attribute::Boolean, PerlBean::Attribute::Factory, PerlBean::Attribute::Multi, PerlBean::Attribute::Multi::Ordered, PerlBean::Attribute::Multi::Unique, PerlBean::Attribute::Multi::Unique::Associative, PerlBean::Attribute::Multi::Unique::Associative::MethodKey, PerlBean::Attribute::Multi::Unique::Ordered, PerlBean::Attribute::Single, PerlBean::Collection, PerlBean::Dependency, PerlBean::Dependency::Import, PerlBean::Dependency::Require, PerlBean::Dependency::Use, PerlBean::Described, PerlBean::Described::ExportTag, PerlBean::Method::Constructor, PerlBean::Method::Factory, PerlBean::Style, PerlBean::Symbol
None known (yet.)
First development: January 2003 Last update: September 2003
Vincenzo Zocca
Copyright 2003 by Vincenzo Zocca
This file is part of the PerlBean module hierarchy for Perl by Vincenzo Zocca.
The PerlBean module hierarchy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
The PerlBean module hierarchy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with the PerlBean module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
To install PerlBean, copy and paste the appropriate command in to your terminal.
cpanm
cpanm PerlBean
CPAN shell
perl -MCPAN -e shell install PerlBean
For more information on module installation, please visit the detailed CPAN module installation guide.