table of contents
Config::Model::HashId(3pm) | User Contributed Perl Documentation | Config::Model::HashId(3pm) |
NAME¶
Config::Model::HashId - Handle hash element for configuration modelVERSION¶
version 2.097SYNOPSIS¶
See "SYNOPSIS" in Config::Model::AnyIdDESCRIPTION¶
This class provides hash elements for a Config::Model::Node.The hash index can either be en enumerated type, a boolean, an integer or a string.
CONSTRUCTOR¶
HashId object should not be created directly.Hash model declaration¶
See model declaration section from Config::Model::AnyId.Methods¶
get_type¶
Returns "hash".fetch_size¶
Returns the number of elements of the hash.sort¶
Sort an ordered hash. Throws an error if called on a non ordered hash.insort¶
Parameters: keyCreate a new element in the ordered hash while keeping alphabetical order of the keys
Returns the newly created element.
Throws an error if called on a non ordered hash.
firstkey¶
Returns the first key of the hash. Behaves like "each" core perl function.nextkey¶
Returns the next key of the hash. Behaves like "each" core perl function.swap ( key1 , key2 )¶
Swap the order of the 2 keys. Ignored for non ordered hash.move ( key1 , key2 )¶
Rename key1 in key2.Also also optional check parameter to disable warning:
move ('foo','bar', check => 'no')
move_after ( key_to_move [ , after_this_key ] )¶
Move the first key after the second one. If the second parameter is omitted, the first key is placed in first position. Ignored for non ordered hash.move_up ( key )¶
Move the key up in a ordered hash. Attempt to move up the first key of an ordered hash is ignored. Ignored for non ordered hash.move_down ( key )¶
Move the key down in a ordered hash. Attempt to move up the last key of an ordered hash is ignored. Ignored for non ordered hash.load_data ( data => ( hash_ref | array_ref ) [ , check => ... , ... ])¶
Load check_list as a hash ref for standard hash.Ordered hash should be loaded with an array ref or with a hash containing a special "__order" element. E.g. loaded with either:
[ a => 'foo', b => 'bar' ]
or
{ __order => ['a','b'], b => 'bar', a => 'foo' }
load_data can also be called with a single ref parameter.
AUTHOR¶
Dominique Dumont, (ddumont at cpan dot org)SEE ALSO¶
Config::Model, Config::Model::Instance, Config::Model::AnyId, Config::Model::ListId, Config::Model::ValueAUTHOR¶
Dominique DumontCOPYRIGHT AND LICENSE¶
This software is Copyright (c) 2005-2016 by Dominique Dumont.This is free software, licensed under:
The GNU Lesser General Public License, Version 2.1, February 1999
2017-05-14 | perl v5.24.1 |