The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
PerlBean-1.0
River stage zero No dependents
++
/ PerlBean::Method::Constructor

NAME

PerlBean::Method::Constructor - contains bean constructor method information

SYNOPSIS

 TODO

ABSTRACT

Abstract PerlBean method information

DESCRIPTION

PerlBean::Method class for bean constructor method information. This is a subclass from PerlBean::Method with the purpose to differentiate between plain methods and constructors.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new PerlBean::Method::Constructor 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.

Options for OPT_HASH_REF inherited through package PerlBean::Method 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().

METHODS

get_body()

This method is inherited from package PerlBean::Method. Returns the method's body.

get_description()

This method is inherited from package PerlBean::Method. Returns the method description.

get_exception_class()

This method is inherited from package PerlBean::Method. Returns the class to throw in eventual interface implementations.

get_method_name()

This method is inherited from package PerlBean::Method. Returns the method's name.

get_package()

This method is inherited from package PerlBean::Method. 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.

get_parameter_description()

This method is inherited from package PerlBean::Method. Returns the parameter description.

get_perl_bean()

This method is inherited from package PerlBean::Method. Returns the PerlBean to which this method belongs.

is_documented()

This method is inherited from package PerlBean::Method. Returns whether the method is documented or not.

is_implemented()

This method is inherited from package PerlBean::Method. Returns whether the method is implemented or not.

is_interface()

This method is inherited from package PerlBean::Method. Returns whether the method is defined as interface or not.

is_volatile()

This method is inherited from package PerlBean::Method. Returns whether the method is volatile or not.

set_body(VALUE)

This method is inherited from package PerlBean::Method. Set the method's body. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
.*
set_description(VALUE)

This method is inherited from package PerlBean::Method. Set the method description. VALUE is the value. On error an exception Error::Simple is thrown.

set_documented(VALUE)

This method is inherited from package PerlBean::Method. State that the method is documented. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.

set_exception_class(VALUE)

This method is inherited from package PerlBean::Method. 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.

set_implemented(VALUE)

This method is inherited from package PerlBean::Method. State that the method is implemented. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.

set_interface(VALUE)

This method is inherited from package PerlBean::Method. State that the method is defined as interface. VALUE is the value. On error an exception Error::Simple is thrown.

set_method_name(VALUE)

This method is inherited from package PerlBean::Method. Set the method's name. VALUE is the value. VALUE may not be undef. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\w+$
set_parameter_description(VALUE)

This method is inherited from package PerlBean::Method. Set the parameter description. VALUE is the value. On error an exception Error::Simple is thrown.

set_perl_bean(VALUE)

This method is inherited from package PerlBean::Method. Set the PerlBean to which this method belongs. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must be a (sub)class of:
PerlBean
set_volatile(VALUE)

This method is inherited from package PerlBean::Method. State that the method is volatile. VALUE is the value. On error an exception Error::Simple is thrown.

write_code(FILEHANDLE)

This method is inherited from package PerlBean::Method. Write the code for the method to FILEHANDLE. FILEHANDLE is an IO::Handle object. On error an exception Error::Simple is thrown.

write_pod(FILEHANDLE)

This method is inherited from package PerlBean::Method. Write the documentation for the method to FILEHANDLE. FILEHANDLE is an IO::Handle object. On error an exception Error::Simple is thrown.

SEE ALSO

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, PerlBean::Method::Factory, PerlBean::Style, PerlBean::Symbol

BUGS

None known (yet.)

HISTORY

First development: February 2003 Last update: September 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

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