/ 
Data-Object-0.53
River stage one • 1 direct dependent • 1 total dependent
/ Data::Object::Role::Integer

NAME

Data::Object::Role::Integer - Integer Object Role for Perl 5

VERSION

version 0.53

SYNOPSIS

use Data::Object::Role::Integer;

DESCRIPTION

Data::Object::Role::Integer provides routines for operating on Perl 5 integer data.

METHODS

data

# given $integer

$integer->data; # original value

The data method returns the original and underlying value contained by the object. This method is an alias to the detract method.

defined

# given $integer

$integer->defined; # 1

The defined method returns true if the object represents a value that meets the criteria for being defined, otherwise it returns false. This method returns a number object.

detract

# given $integer

$integer->detract; # original value

The detract method returns the original and underlying value contained by the object.

downto

# given 1

$integer->downto(0); # [1,0]

The downto method returns an array reference containing integer decreasing values down to and including the limit. This method returns a array object.

dump

# given 1

$integer->dump; # '1'

The dump method returns returns a string representation of the object. This method returns a string value.

eq

# given 1

$integer->eq(1); # 1

The eq method performs a numeric equality operation. This method returns a number object representing a boolean.

ge

# given 1

$integer->ge(0); # 1

The ge method returns true if the argument provided is greater-than or equal-to the value represented by the object. This method returns a Data::Object::Number object.

gt

# given 1

$integer->gt(1); # 0

The gt method performs a numeric greater-than comparison. This method returns a number object representing a boolean.

le

# given 0

$integer->le(1); # 1

The le method returns true if the argument provided is less-than or equal-to the value represented by the object. This method returns a Data::Object::Number object.

lt

# given 1

$integer->lt(1); # 0

The lt method performs a numeric less-than comparison. This method returns a number object representing a boolean.

methods

# given $integer

$integer->methods;

The methods method returns the list of methods attached to object. This method returns an array value.

ne

# given 1

$integer->ne(0); # 1

The ne method performs a numeric equality operation. This method returns a number object representing a boolean.

new

# given 9

my $integer = Data::Object::Integer->new(9);

The new method expects a number and returns a new class instance.

print

# given 0

$integer->print; # '0'

The print method outputs the value represented by the object to STDOUT and returns true. This method returns a number value.

roles

# given $integer

$integer->roles;

The roles method returns the list of roles attached to object. This method returns an array value.

say

# given 0

$integer->say; # '0\n'

The say method outputs the value represented by the object appended with a newline to STDOUT and returns true. This method returns a Data::Object::Number object.

throw

# given $integer

$integer->throw;

The throw method terminates the program using the core die keyword, passing the object to the Data::Object::Exception class as the named parameter object. If captured this method returns an exception value.

to

# given 1

$integer->to(2); # [1,2]
$integer->to(0); # [1,0]

The to method returns an array reference containing integer increasing or decreasing values to and including the limit in ascending or descending order based on the value of the floating-point object. This method returns a array object.

type

# given $integer

$integer->type; # INTEGER

The type method returns a string representing the internal data type object name. This method returns a string value.

upto

# given 1

$integer->upto(2); # [1,2]

The upto method returns an array reference containing integer increasing values up to and including the limit. This method returns a array object.

ROLES

This package is comprised of the following roles.

SEE ALSO

AUTHOR

Al Newkirk <anewkirk@ana.io>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Al Newkirk.

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