moosex::attributehelpers::trait::bool(3pm) [debian man page]

MooseX::AttributeHelpers::Trait::Bool(3pm)		User Contributed Perl Documentation		MooseX::AttributeHelpers::Trait::Bool(3pm)

NAME

       MooseX::AttributeHelpers::Bool - simple boolean attribute

SYNOPSIS

	 package Room;
	 use Moose;
	 use MooseX::AttributeHelpers;

	 has 'is_lit' => (
	     metaclass => 'Bool',
	     is        => 'rw',
	     isa       => 'Bool',
	     default   => sub { 0 },
	     provides  => {
		 set	 => 'illuminate',
		 unset	 => 'darken',
		 toggle  => 'flip_switch',
		 not	 => 'is_dark'
	     }
	 );

	 my $room = Room->new();
	 $room->illuminate;	# same as $room->is_lit(1);
	 $room->darken; 	# same as $room->is_lit(0);
	 $room->flip_switch;	# same as $room->is_lit(not $room->is_lit);
	 return $room->is_dark; # same as !$room->is_lit

DESCRIPTION

       This provides a simple boolean attribute, which supports most of the basic math operations.

METHODS

       meta
       helper_type
       method_constructors
       has_method_provider
       method_provider

PROVIDED METHODS

       It is important to note that all those methods do in place modification of the value stored in the attribute.

       set Sets the value to 1.

       unset
	   Set the value to 0.

       toggle
	   Toggle the value. If it's true, set to false, and vice versa.

       not Equivalent of 'not $value'.

BUGS

       All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to
       cpan-RT.

AUTHOR

       Jason May

COPYRIGHT AND LICENSE

       Copyright 2007-2009 by Infinity Interactive, Inc.

       <http://www.iinteractive.com>

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.10.1							    2010-01-02				MooseX::AttributeHelpers::Trait::Bool(3pm)

Moose::Meta::Attribute::Native::Trait::Bool(3)		User Contributed Perl Documentation	    Moose::Meta::Attribute::Native::Trait::Bool(3)

NAME

       Moose::Meta::Attribute::Native::Trait::Bool - Helper trait for Bool attributes

VERSION

       version 2.0604

SYNOPSIS

	 package Room;
	 use Moose;

	 has 'is_lit' => (
	     traits  => ['Bool'],
	     is      => 'rw',
	     isa     => 'Bool',
	     default => 0,
	     handles => {
		 illuminate  => 'set',
		 darken      => 'unset',
		 flip_switch => 'toggle',
		 is_dark     => 'not',
	     },
	 );

	 my $room = Room->new();
	 $room->illuminate;	   # same as $room->is_lit(1);
	 $room->darken; 	   # same as $room->is_lit(0);
	 $room->flip_switch;	   # same as $room->is_lit(not $room->is_lit);
	 return $room->is_dark;    # same as !$room->is_lit

DESCRIPTION

       This trait provides native delegation methods for boolean values. A boolean is a scalar which can be 1, 0, "", or "undef".

DEFAULT TYPE

       If you don't provide an "isa" value for your attribute, it will default to "Bool".

PROVIDED METHODS

       None of these methods accept arguments.

       o   set

	   Sets the value to 1 and returns 1.

       o   unset

	   Set the value to 0 and returns 0.

       o   toggle

	   Toggles the value. If it's true, set to false, and vice versa.

	   Returns the new value.

       o   not

	   Equivalent of 'not $value'.

BUGS

       See "BUGS" in Moose for details on reporting bugs.

AUTHOR

       Moose is maintained by the Moose Cabal, along with the help of many contributors. See "CABAL" in Moose and "CONTRIBUTORS" in Moose for
       details.

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Infinity Interactive, Inc..

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.16.2							    2012-09-19			    Moose::Meta::Attribute::Native::Trait::Bool(3)