trusty (3) Lire::Config::Value.3pm.gz

NAME

       Lire::Config::Value - Lire value containers for configuration variables

SYNOPSIS

         use base qw/ Lire::Config::Value /;

DESCRIPTION

       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.

AUTHORS

         Wessel Dankers <wsl@logreport.org>
         Francis J. Lacoste <flacoste@logreport.org>
         Wolfgang Sourdeau <wolfgang@logreport.org>

VERSION

       $Id: Value.pm,v 1.18 2008/03/09 19:27:31 vanbaal Exp $

COPYRIGHT

       Copyright (C) 2002-2004 Stichting LogReport Foundation LogReport@LogReport.org

       This file is part of Lire.

       Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
       License as published by the Free Software Foundation; either version 2 of the License, or (at your
       option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
       the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
       License for more details.

       You should have received a copy of the GNU General Public License along with this program (see COPYING);
       if not, check with http://www.gnu.org/copyleft/gpl.html.