GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DATA::OBJECT::ROLE::UNDEF (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

version 0.59

SYNOPSIS



    use Data::Object::Class;

    with Data::Object::Role::Undef;



DESCRIPTION

Data::Object::Role::Undef provides functions for operating on Perl 5 undefined data.

METHODS

    data



    # given $undef

    $undef->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 undef

    $undef->defined ? Yes : No; # No



The defined method always returns false. This method returns a number object.

    detract



    # given $undef

    $undef->detract; # original value



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

    dump



    # given $undef

    $undef->dump; # undef



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

    eq



    # given $undef

    $undef->eq; # exception thrown



This method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

    ge



    # given $undef

    $undef->ge; # exception thrown



This method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

    gt



    # given $undef

    $undef->gt; # exception thrown



This method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

    le



    # given $undef

    $undef->le; # exception thrown



This method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

    lt



    # given $undef

    $undef->lt; # exception thrown



This method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

    methods



    # given $undef

    $undef->methods;



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

    ne



    # given $undef

    $undef->ne; # exception thrown



This method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

    new



    # given undef

    my $undef = Data::Object::Undef->new(undef);



The new method expects an undefined value and returns a new class instance.

    print



    # given $undef

    $undef->print; # undef



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

    roles



    # given $undef

    $undef->roles;



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

    say



    # given $undef

    $undef->say; # undef\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 $undef

    $undef->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.

    type



    # given $undef

    $undef->type; # UNDEF



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

ROLES

This package is comprised of the following roles.
o Data::Object::Role::Comparison
o Data::Object::Role::Defined
o Data::Object::Role::Detract
o Data::Object::Role::Dumper
o Data::Object::Role::Item
o Data::Object::Role::Output
o Data::Object::Role::Throwable
o Data::Object::Role::Type
o Data::Object::Role::Value

SEE ALSO

o Data::Object::Array
o Data::Object::Class
o Data::Object::Class::Syntax
o Data::Object::Code
o Data::Object::Float
o Data::Object::Hash
o Data::Object::Integer
o Data::Object::Number
o Data::Object::Role
o Data::Object::Role::Syntax
o Data::Object::Regexp
o Data::Object::Scalar
o Data::Object::String
o Data::Object::Undef
o Data::Object::Universal
o Data::Object::Autobox
o Data::Object::Immutable
o Data::Object::Library
o Data::Object::Prototype
o 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 DATA::OBJECT::ROLE::UNDEF (3) 2015-11-29

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.