Dominique Dumont > Config-Model > Config::Model::HashId

Download:
Config-Model-0.640.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 1.0905   Source  

NAME ^

Config::Model::HashId - Handle hash element for configuration model

SYNOPSIS ^

 $model ->create_config_class 
  (
   ...
   element 
   => [ 
       bounded_hash 
       => { type => 'hash',
            index_type  => 'integer',
            min => 1, 
            max => 123, 
            max_nb => 2 ,
            cargo_type => 'leaf',
            cargo_args => {value_type => 'string'},
          },
      ]
  ) ;

DESCRIPTION ^

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 nb of elements of the 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.

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 will be 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 will be ignored. Ignored for non ordered hash.

load_data ( hash_ref | array_ref)

Load check_list as a hash ref for standard hash. Ordered hash must be loaded with a array ref.

AUTHOR ^

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO ^

Config::Model, Config::Model::Instance, Config::Model::AnyId, Config::Model::ListId, Config::Model::Value