Moose::Meta::Attribute::Native::Trait::Counter (3)
Leading comments
Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) Standard preamble: ========================================================================
NAME
Moose::Meta::Attribute::Native::Trait::Counter - Helper trait for Int attributes which represent counters
VERSION
version 2.1807
SYNOPSIS
package MyHomePage;
use Moose;
has 'counter' => (
traits => ['Counter'],
is => 'ro',
isa => 'Num',
default => 0,
handles => {
inc_counter => 'inc',
dec_counter => 'dec',
reset_counter => 'reset',
},
);
my $page = MyHomePage->new();
$page->inc_counter; # same as $page->counter( $page->counter + 1 );
$page->dec_counter; # same as $page->counter( $page->counter - 1 );
my $count_by_twos = 2;
$page->inc_counter($count_by_twos);
DESCRIPTION
This trait provides native delegation methods for counters. A counter can be any sort of number (integer or not). The delegation methods allow you to increment, decrement, or reset the value.
DEFAULT TYPE
If you don't provide an "isa" value for your attribute, it will default to "Num".
PROVIDED METHODS
o set($value)
Sets the counter to the specified value and returns the new value.
This method requires a single argument.
o inc
o inc($arg)
Increases the attribute value by the amount of the argument, or by 1 if no argument is given. This method returns the new value.
This method accepts a single argument.
o dec
o dec($arg)
Decreases the attribute value by the amount of the argument, or by 1 if no argument is given. This method returns the new value.
This method accepts a single argument.
o reset
Resets the value stored in this slot to its default value, and returns the new value.
BUGS
See "BUGS" in Moose for details on reporting bugs.
AUTHORS
o Stevan Little
o Dave Rolsky
o Jesse Luehrs
o Shawn M Moore
o
' (Yuval Kogman)
o Karen Etheridge
o Florian Ragwitz
o Hans Dieter Pearcey
o Chris Prather
o Matt S Trout
COPYRIGHT AND LICENSE
This software is copyright (c) 2006 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.