Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Data::Object::Regexp(3User Contributed Perl DocumentatiData::Object::Regexp(3)

NAME
       Data::Object::Regexp - Regexp Object for	Perl 5

VERSION
       version 0.59

SYNOPSIS
	   use Data::Object::Regexp;

	   my $re = Data::Object::Regexp->new(qr(something to match against));

DESCRIPTION
       Data::Object::Regexp provides routines for operating on Perl 5 regular
       expressions. Data::Object::Regexp methods work on data that meets the
       criteria	for being a regular expression.

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

METHODS
   data
	   # given $regexp

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

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

	   $regexp->detract; # original	value

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

   dump
	   # given qr(test)

	   $regexp->dump; # qr/(?^u:test)/

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

   eq
	   # given qr(test)

	   $regexp->eq(qr(test)); # 1

       The eq method returns true if the argument provided is equal to the
       value represented by the	object.	This method returns a
       Data::Object::Number object.

   ge
	   # given qr(test)

	   $regexp->ge(qr(test)); # 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 qr(test)

	   $regexp->gt(qr(test)); # 0

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

   le
	   # given qr(test)

	   $regexp->le(qr(test)); # 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 qr(test)

	   $regexp->lt(qr(test)); # 0

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

   methods
	   # given $regexp

	   $regexp->methods;

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

   ne
	   # given qr(test)

	   $regexp->ne(qr(test)); # 1

       The ne method returns true if the argument provided is not equal	to the
       value represented by the	object.	This method returns a
       Data::Object::Number object.

   new
	   # given qr(something	to match against)

	   my $re = Data::Object::Regexp->new(qr(something to match against));

       The new method expects a	regular-expression object and returns a	new
       class instance.

   print
	   # given qr(test)

	   $regexp->print; # 'qr/(?^u:test)/'

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

   replace
	   # given qr(test)

	   $re->replace('this is a test', 'drill');
	   $re->replace('test 1	test 2 test 3',	'drill', 'gi');

       The replace method performs a regular expression	substitution on	the
       given string. The first argument	is the string to match against.	 The
       second argument is the replacement string.  The optional	third argument
       might be	a string representing flags to append to the s///x operator,
       such as 'g' or 'e'.  This method	will always return a
       Data::Object::Regexp::Result object which can be	used to	introspect the
       result of the operation.

   roles
	   # given $regexp

	   $regexp->roles;

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

   say
	   # given qr(test)

	   $regexp->say; # 'qr/(?^u:test)/\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.

   search
	   # given qr((test))

	   $re->search('this is	a test');
	   $re->search('this does not match', 'gi');

       The search method performs a regular expression match against the given
       string This method will always return a Data::Object::Regexp::Result
       object which can	be used	to introspect the result of the	operation.

   throw
	   # given $regexp

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

   type
	   # given $regexp

	   $regexp->type; # REGEXP

       The type	method returns a string	representing the internal data type
       object name.  This method returns a Data::Object::String	object.

ROLES
       This package is comprised of the	following roles.

       o   Data::Object::Role::Alphabetic

       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.

perl v5.24.1			  2015-11-29	       Data::Object::Regexp(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | COMPOSITION | METHODS | ROLES | SEE ALSO | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Data::Object::Regexp&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help