/ 
PerlBean-1.0
River stage zero No dependents
/ PerlBean::Attribute

NAME

PerlBean::Attribute - contains bean attribute information

SYNOPSIS

None. This is an abstract class.

ABSTRACT

Abstract PerlBean attribute information

DESCRIPTION

PerlBean::Attribute abstract class for bean attribute information. Attribute access methods are implemented and code and documentation generation interface methods are defined.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new PerlBean::Attribute 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 may include:

default_value

Passed to set_default_value().

documented

Passed to set_documented(). Defaults to 1.

exception_class

Passed to set_exception_class(). Defaults to 'Error::Simple'.

mandatory

Passed to set_mandatory(). Defaults to 0.

method_base

Passed to set_method_base().

short_description

Passed to set_short_description().

Options for OPT_HASH_REF inherited through package PerlBean::Method::Factory may include:

method_factory_name

Passed to set_method_factory_name(). Mandatory option.

perl_bean

Passed to set_perl_bean().

METHODS

create_methods()

This is an interface method. Returns a list of PerlBean::Attribute::Method objects.

get_default_value()

Returns attribute default value.

get_exception_class()

Returns the class to throw when an exception occurs.

get_method_base()

Returns the method base name.

get_method_factory_name()

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

get_package()

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_package_us()

Calls get_package() and replaces :+ with C <_>.

get_perl_bean()

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

get_short_description()

Returns the attribute description.

is_documented()

Returns whether the attribute is documented or not.

is_mandatory()

Returns whether the attribute is mandatory for construction or not.

mk_doc_clauses()

Returns a string containing the documentation for the clauses to which the contents the contents of the attribute must adhere.

set_default_value(VALUE)

Set attribute default value. VALUE is the value. On error an exception Error::Simple is thrown.

set_documented(VALUE)

State that the attribute is documented. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.

set_exception_class(VALUE)

Set the class to throw when an exception occurs. 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_mandatory(VALUE)

State that the attribute is mandatory for construction. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

set_method_base(VALUE)

Set the method base name. VALUE is the value. On error an exception Error::Simple is thrown.

set_method_factory_name(VALUE)

This method is inherited from package PerlBean::Method::Factory. Set method factory'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_perl_bean(VALUE)

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

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

Set the attribute description. VALUE is the value. On error an exception Error::Simple is thrown.

type()

Determines and returns the type of the attribute. The type is either BOOLEAN, SINGLE or MULTI.

write_constructor_option_code()

This is an interface method. Writes constructor code for the attribute option.

write_constructor_option_doc()

This is an interface method. Writes constructor documentation for the attribute option.

write_default_value()

This is an interface method. Returns a %DEFAULT_VALUE line string for the attribute.

SEE ALSO

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

BUGS

None known (yet.)

HISTORY

First development: November 2002 Last update: September 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2002, 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