Lire::Config::Value3pm
Lire value containers for configuration variables
Usage
use base qw/ Lire::Config::Value /;Overview
Value containers for configuration variables. This is the abstract superclass for the other Lire::Config::Value classes.
new( ['spec' => $spec], ... )
This is the constructor for the value object. Lire::Config::Value objects should be instantiated from the instance() method defined in the TypeSpec object.
name()
Returns this configuration parameter's name.
spec()
Returns the specification for this parameter.
summary()
Returns the specification's summary for this value.
description()
Returns the specification's description for this value.
text_description()
Returns the specification's description (formatted in plain text) for this value.
as_value()
Returns this value as a perl native value. This will be either a scalar value, or an hash or array references. The returned values should be normalized.
as_label()
Return the label of this object for displaying in GUI's.
as_shell_var()
Returns this configuration variable's value in a form that can be evaled in a shell script.
clone()
Return a deep_copie'd value of this instance. The reference to the spec is kept but is not copied.
is_equals( $param )
Returns if the $param instance is identifcal to this one.
is_valid()
Checks that the current value is valid according to the specification.
is_default()
Returns true if this value is equals to its specification's default.
save_xml( $fh )
Writes an XML configuration of the variable recursively on $fh.
Version
$Id: Value.pm,v 1.18 2008/03/09 19:27:31 vanbaal Exp $
Releases
6 releases since Debian 3.1 (Sarge); the text changed 5 times.