NAME

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

VERSION

version 0.59

SYNOPSIS

    use Data::Object::Integer;

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

DESCRIPTION

Data::Object::Integer provides routines for operating on Perl 5 integer data. Integer methods work on data that meets the criteria for being an integer. An integer holds and manipulates an arbitrary sequence of bytes, typically representing numeric characters. Users of integers should be aware of the methods that modify the integer itself as opposed to returning a new integer. Unless stated, it may be safe to assume that the following methods copy, modify and return new integers based on their function.

COMPOSITION

This package inherits all functionality from the Data::Object::Role::Integer role and implements proxy methods as documented herewith.

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 Data::Object::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 Data::Object::Array object.

dump

    # given 1

    $integer->dump; # '1'

The dump method returns returns a string representation of the object. This method returns a Data::Object::String object.

eq

    # given 1

    $integer->eq(1); # 1

The eq method performs a numeric equality operation. This method returns a Data::Object::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 Data::Object::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 Data::Object::Number object representing a boolean.

methods

    # given $integer

    $integer->methods;

The methods method returns the list of methods attached to object. This method returns a Data::Object::Array object.

ne

    # given 1

    $integer->ne(0); # 1

The ne method performs a numeric equality operation. This method returns a Data::Object::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 Data::Object::Number object.

roles

    # given $integer

    $integer->roles;

The roles method returns the list of roles attached to object. This method returns a Data::Object::Array object.

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 a Data::Object::Exception object.

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 Data::Object::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 Data::Object::String object.

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 Data::Object::Array object.

ROLES

This package is comprised of the following roles.

• Data::Object::Role::Comparison

• Data::Object::Role::Defined

• Data::Object::Role::Detract

• Data::Object::Role::Dumper

• Data::Object::Role::Item

• Data::Object::Role::Numeric

• Data::Object::Role::Output

• Data::Object::Role::Throwable

• Data::Object::Role::Type

• Data::Object::Role::Value

SEE ALSO

• Data::Object::Array

• Data::Object::Class

• Data::Object::Class::Syntax

• Data::Object::Code

• Data::Object::Float

• Data::Object::Hash

• Data::Object::Integer

• Data::Object::Number

• Data::Object::Role

• Data::Object::Role::Syntax

• Data::Object::Regexp

• Data::Object::Scalar

• Data::Object::String

• Data::Object::Undef

• Data::Object::Universal

• Data::Object::Autobox

• Data::Object::Immutable

• Data::Object::Library

• Data::Object::Prototype

• Data::Object::Signatures

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.

cpanm Data::Object

perl -MCPAN -e shell
install Data::Object