NAME

Data::Object::Scalar

ABSTRACT

Data-Object Scalar Class

SYNOPSIS

  use Data::Object::Scalar;

  my $scalar = Data::Object::Scalar->new(\*main);

DESCRIPTION

Data::Object::Scalar provides routines for operating on Perl 5 scalar objects. Scalar methods work on data that meets the criteria for being a scalar.

METHODS

This package implements the following methods.

defined

  defined() : NumObject

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.

defined example
  # given $scalar

  $scalar->defined; # 1

eq

  eq(Any $arg1) : NumObject

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

eq example
  # given $scalar

  $scalar->eq; # exception thrown

ge

  ge(Any $arg1) : NumObject

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

ge example
  # given $scalar

  $scalar->ge; # exception thrown

gt

  gt(Any $arg1) : NumObject

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

gt example
  # given $scalar

  $scalar->gt; # exception thrown

le

  le(Any $arg1) : NumObject

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

le example
  # given $scalar

  $scalar->le; # exception thrown

lt

  lt(Any $arg1) : NumObject

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

lt example
  # given $scalar

  $scalar->lt; # exception thrown

ne

  ne(Any $arg1) : NumObject

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

ne example
  # given $scalar

  $scalar->ne; # exception thrown

new

  new(ScalarRef $arg1) : ScalarObject

The new method expects a scalar reference and returns a new class instance.

new example
  # given \*main

  my $scalar = Data::Object::Scalar->new(\*main);

roles

  roles() : ArrayRef

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

roles example
  # given $scalar

  $scalar->roles;

rules

  rules() : ArrayRef

The rules method returns consumed rules.

rules example
  my $rules = $scalar->rules;

ROLES

This package inherits all behavior from the folowing role(s):

RULES

This package adheres to the requirements in the folowing rule(s):