The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Config::Objective::DataType - base class for Config::Objective data types

SYNOPSIS

  use Config::Objective;
  use Config::Objective::DataType;

  my $conf = Config::Objective->new('filename', {
                'objname'       => Config::Objective::DataType->new(
                                        'attr1' => 0,
                                        'attr2' => "string",
                                        ...
                                )
        });

DESCRIPTION

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

The Config::Objective::DataType class is not intended to be used to directly instantiate configuration objects, but it does support the following methods for use in subclasses:

new()

The constructor. It can be passed a hash to set the object's attributes. The object will be created as a reference to this hash.

The value encapsulated by the object is stored in the "value" attribute. Setting this attribute in the constructor call will set the initial value for the object. If no initial value is supplied, the constructor will call the undef() method.

The Config::Objective::DataType class does not use any other attributes. However, they can be useful in subclasses.

set()

Sets the object's value to the supplied value.

get()

Returns the object's value.

unset()

Sets the object's value to undef.

default()

Calls the set() method.

AUTHOR

Mark D. Roth <roth@uiuc.edu>

SEE ALSO

perl

Config::Objective