Config::Model::ListId - Handle list element for configuration model
version 2.047
See "SYNOPSIS" in Config::Model::AnyId
This class provides list elements for a Config::Model::Node.
ListId object should not be created directly.
See model declaration section from Config::Model::AnyId.
Returns list.
list
Returns the number of elements of the list.
Store a set of values passed as a comma separated list of values. Values can be quoted strings. (i.e "a,a",b will yield ('a,a', 'b') list).
"a,a",b
('a,a', 'b')
check can be yes, no or skip
check
Store a set of values (passed as list)
If tinkering with check is required, use the following way :
store_set ( \@v , check => 'skip' );
Move an element within the list. check can be 'yes' 'no' 'skip'
push some values at the end of the list.
Like push with extended options. Options are:
Check value validaty. Either yes (default), no, skip
yes
no
skip
Values to push (array_ref)
Single value to push
Equivalent to push_x. This method is provided to help write configuration parser, so the call is the same when dealing with leaf or list values. Prefer push_x when practical.
push_x
yes, no or skip
list ref of annotation to store with the list values
Example:
$elt->push_x ( values => [ 'v1','v2' ] , annotation => [ 'v1 comment', 'v2 comment' ], check => 'skip' );
ida
idb
Swap 2 elements within the array
idx
Remove an element from the list. Equivalent to splice @list,$idx,1
splice @list,$idx,1
Clear and load list from data contained in the data array ref. If a scalar or a hash ref is passed, the list is cleared and the data is stored in the first element of the list. If split_reg is specified, the scalar will be split to load the array.
data
For instance
$elt->load_data( data => 'foo,bar', split_reg => qr(,) ) ;
will load [ 'foo','bar'] in $elt
[ 'foo','bar']
$elt
Dominique Dumont, (ddumont at cpan dot org)
Config::Model::Model, Config::Model::Instance, Config::Model::AnyId, Config::Model::HashId, Config::Model::Value
Dominique Dumont
This software is Copyright (c) 2013 by Dominique Dumont.
This is free software, licensed under:
The GNU Lesser General Public License, Version 2.1, February 1999
To install Config::Model, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Config::Model
CPAN shell
perl -MCPAN -e shell install Config::Model
For more information on module installation, please visit the detailed CPAN module installation guide.