Mark D. Roth > Config-Objective-0.9.1 > Config::Objective::String

Download:
Config-Objective-0.9.1.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Config::Objective::String - string data type class for Config::Objective

SYNOPSIS ^

  use Config::Objective;
  use Config::Objective::String;

  my $conf = Config::Objective->new('filename', {
                        'stringobj'     => Config::Objective::String->new()
                });

DESCRIPTION ^

The Config::Objective::String module provides a class that represents a string value in an object so that it can be used with Config::Objective. Its methods can be used to manipulate the encapsulated string value from the config file.

The Config::Objective::String class is derived from the Config::Objective::DataType class, but it defines/overrides the following methods:

set()

Sets the object's value to its argument. The value must be a scalar.

If the object was created with the value_abspath attribute enabled, the value must be an absolute path string.

If the object was created with the value_optional attribute enabled, the argument is optional; if missing, an empty string will be used instead.

append()

Appends its argument to the object's value using string concatenation.

prepend()

Prepends its argument to the object's value using string concatenation.

gsub()

For each substring matching the first argument in the object's value, substitutes the second argument.

equals()

Returns true if the argument equals the object's value. The comparison is done using the perl "eq" operator.

match()

Returns true if the object's value matches the argument. The comparison is done using the argument as a case-insensitive regular expression.

AUTHOR ^

Mark D. Roth <roth@uiuc.edu>

SEE ALSO ^

perl

Config::Objective

Config::Objective::DataType

syntax highlighting: