Lire::Param(3pm)

Lire::Param3pm

Object which represents a parameter in a xml specification.

Overview

Lire::Param are objects which represent parameters in an XML specification. The object is used to represent the parameter's specification as well as its current value.

new( 'name' => $name, 'type' => $type, [ 'default' => $default ] )

Creates a new Lire::Param object.

name()

Returns the name of this parameter.

type()

Returns this parameter's type.

value( [ $new_value ] )

Returns (and optionnally modifies) the current value for this parameter. If no value was set, but a default is available, the default value will be returned.

default( [ $new_default ] )

Returns (and optionnally changes) the parameter's default value.

description( [ $new_description ] )

Returns (and optionnally changes) the current parameter's description.

as_type_spec()

Returns a Lire::Config::TypeSpec object which adequately represents the current parameter.

Version

$Id: Param.pm,v 1.13 2006/07/23 13:16:29 vanbaal Exp $

Releases

5 releases since Debian 4.0 (Etch); the text changed 4 times.

  1. 4.0
  2. 5.0
  3. 6.0
  4. 7
  5. Arch

Author

  Francis J. Lacoste <[email protected]>

From lire 2.1.1-8 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.