PerlBean::Attribute::Boolean - contains BOOLEAN bean attribute information

PerlBean documentation Contained in the PerlBean distribution.

Index

Code Index:

NAME

Top

PerlBean::Attribute::Boolean - contains BOOLEAN bean attribute information

SYNOPSIS

Top

 use strict;
 use PerlBean::Attribute::Boolean;
 my $attr = PerlBean::Attribute::Boolean->new( {
     method_factory_name => 'true',
     short_description => 'something is true',
 } );

ABSTRACT

Top

BOOLEAN bean attribute information

DESCRIPTION

Top

PerlBean::Attribute::Boolean contains BOOLEAN bean attribute information. It is a subclass of PerlBean::Attribute. The code generation and documentation methods are implemented.

CONSTRUCTOR

Top

new(OPT_HASH_REF)

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

Top

create_methods()

This method is an implementation from package PerlBean::Attribute. Returns a list of PerlBean::Attribute::Method objects.

get_default_value()

This method is inherited from package PerlBean::Attribute. Returns attribute default value.

get_exception_class()

This method is inherited from package PerlBean::Attribute. Returns the class to throw when an exception occurs.

get_method_base()

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

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

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

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

is_documented()

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

is_mandatory()

This method is inherited from package PerlBean::Attribute. Returns whether the attribute is mandatory for construction or not.

mk_doc_clauses()

This method is overloaded from package PerlBean::Attribute. Returns a string containing the documentation for the clauses to which the contents the contents of the attribute must adhere.

set_default_value(VALUE)

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

set_documented(VALUE)

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

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

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

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

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

type()

This method is inherited from package PerlBean::Attribute. Determines and returns the type of the attribute. The type is either BOOLEAN, SINGLE or MULTI.

write_constructor_option_code()

This method is an implementation from package PerlBean::Attribute. Writes constructor code for the attribute option.

write_constructor_option_doc()

This method is an implementation from package PerlBean::Attribute. Writes constructor documentation for the attribute option.

write_default_value()

This method is an implementation from package PerlBean::Attribute. Returns a %DEFAULT_VALUE line string for the attribute.

SEE ALSO

Top

PerlBean, PerlBean::Attribute, 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

Top

None known (yet.)

HISTORY

Top

First development: November 2002 Last update: September 2003

AUTHOR

Top

Vincenzo Zocca

COPYRIGHT

Top

Copyright 2002, 2003 by Vincenzo Zocca

LICENSE

Top

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

PerlBean documentation Contained in the PerlBean distribution. 
package PerlBean::Attribute::Boolean;

use 5.005;
use base qw( PerlBean::Attribute );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);
use PerlBean::Style qw(:codegen);

# Package version
our ($VERSION) = '$Revision: 1.0 $' =~ /\$Revision:\s+([^\s]+)/;

1;

__END__


sub create_method_is {
    my $self = shift;

    my $an = $self->get_method_factory_name();
    my $op = &{$MOF}('is');
    my $mb = $self->get_method_base();
    my $pkg_us = $self->get_package_us();
    my $desc = defined( $self->get_short_description() ) ? $self->get_short_description() : 'not described option';

    return( PerlBean::Method->new( {
        method_name => "$op$mb",
        volatile => 1,
        documented => $self->is_documented(),
        description => <<EOF,
Returns whether ${desc} or not.
EOF
        body => <<EOF,
${IND}my \$self${AO}=${AO}shift;

${IND}if${BCP}(${ACS}\$self->{$pkg_us}{$an}${ACS})${PBOC[1]}{
${IND}${IND}return${BFP}(1);
${IND}}${PBCC[1]}else${PBOC[1]}{
${IND}${IND}return${BFP}(0);
${IND}}
EOF
    } ) );
}

sub create_method_set {
    my $self = shift;

    my $an = $self->get_method_factory_name();
    my $op = &{$MOF}('set');
    my $mb = $self->get_method_base();
    my $pkg_us = $self->get_package_us();
    my $desc = defined( $self->get_short_description() ) ?
        $self->get_short_description() : 'not described option';
    my $def = defined( $self->get_default_value() ) ?
        ' Default value at initialization is C<' .
            $self->_esc_aq( $self->get_default_value() ) . '>.' :
        '';
    my $exc = ' On error an exception C<' . $self->get_exception_class() .
        '> is thrown.';
    my $attr_overl = $self->_get_overloaded_attribute();
    my $overl = defined($attr_overl) ?
        " B<NOTE:> Methods B<C<*$mb ()>> are overloaded from package C<" .
            $attr_overl->get_perl_bean()->get_package() .'>.' :
        '';

    return( PerlBean::Method->new( {
        method_name => "$op$mb",
        parameter_description => 'VALUE',
        volatile => 1,
        documented => $self->is_documented(),
        description => <<EOF,
State that $desc. C<VALUE> is the value.$def$exc$overl
EOF
        body => <<EOF,
${IND}my \$self${AO}=${AO}shift;

${IND}if${BCP}(shift)${PBOC[1]}{
${IND}${IND}\$self->{$pkg_us}{$an}${AO}=${AO}1;
${IND}}${PBCC[1]}else${PBOC[1]}{
${IND}${IND}\$self->{$pkg_us}{$an}${AO}=${AO}0;
${IND}}
EOF
    } ) );
}

sub create_methods {
    my $self = shift;

    return(
        $self->create_method_is(),
        $self->create_method_set()
    );
}

sub mk_doc_clauses {
    return('');
}

sub write_allow_isa {
    return('');
}

sub write_allow_ref {
    return('');
}

sub write_allow_rx {
    return('');
}

sub write_allow_value {
    return('');
}

sub write_constructor_option_code {
    my $self = shift;

    my $an = $self->get_method_factory_name();
    my $op = &{$MOF}('set');
    my $mb = $self->get_method_base();
    my $ec = $self->get_exception_class();
    my $pkg = $self->get_package();


    # Comment
    my $code = "${IND}# $an, " . $self->type();
    $code .= $self->is_mandatory() ? ', mandatory' : '';
    $code .= defined( $self->get_default_value() ) ? ', with default value' : '';
    $code .= "\n";

    # is_mandatory check
    if ($self->is_mandatory()) {
        $code .= <<EOF;
${IND}exists${BFP}(${ACS}\$opt->{$an}${ACS})${AO}||${AO}throw $ec${BFP}("ERROR: ${pkg}::_initialize, option '$an' is mandatory.");
EOF
    }

    if ( $self->is_mandatory() ) {
        $code .= <<EOF;
${IND}\$self->$op$mb${BFP}(${ACS}\$opt->{$an}${ACS});
EOF
    }
    else {
        if ( defined( $self->get_default_value () ) ) {
            $code .= <<EOF;
${IND}\$self->$op$mb${BFP}(${ACS}exists${BFP}(${ACS}\$opt->{$an}${ACS})${AO}?${AO}\$opt->{$an}${AO}:${AO}\$DEFAULT_VALUE{$an}${ACS});
EOF
        }
        else {
            $code .= <<EOF;
${IND}exists${BFP}(${ACS}\$opt->{$an}${ACS})${AO}&&${AO}\$self->$op$mb${BFP}(${ACS}\$opt->{$an}${ACS});
EOF
        }
    }

    # Empty line
    $code .= "\n";

    return($code);
}

sub write_constructor_option_doc {
    my $self = shift;

    # Do nothing if not documented
    $self->is_documented() || return('');

    my $an = $self->get_method_factory_name();
    my $op = &{$MOF}('set');
    my $mb = $self->get_method_base();
    my $mand = $self->is_mandatory() ? ' Mandatory option.' : '';
    my $def = '';
    if ( defined( $self->get_default_value() ) ) {
        $def = ' Defaults to B<' . $self->_esc_aq( $self->get_default_value() ) . '>.';
    }

    return(<<EOF);

\=item B<C<$an>>

Passed to L<$op$mb${BFP}()>.${mand}${def}
EOF
}

sub write_default_value {
    my $self = shift;

    defined( $self->get_default_value() ) || return('');

    my $an = $self->_esc_aq( $self->get_method_factory_name() );
    my $dv = $self->get_default_value() ? 1 : 0;

    return( "${IND}$an${AO}=>${AO}$dv,\n" );
}