.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Config::Model::HashId 3pm"
.TH Config::Model::HashId 3pm "2021-01-20" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Config::Model::HashId \- Handle hash element for configuration model
.SH "VERSION"
.IX Header "VERSION"
version 2.141
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
See \*(L"\s-1SYNOPSIS\*(R"\s0 in Config::Model::AnyId
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides hash elements for a Config::Model::Node.
.PP
The hash index can either be en enumerated type, a boolean, an integer
or a string.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
HashId object should not be created directly.
.SH "Hash model declaration"
.IX Header "Hash model declaration"
See
model declaration section
from Config::Model::AnyId.
.SH "Methods"
.IX Header "Methods"
.SS "get_type"
.IX Subsection "get_type"
Returns \f(CW\*(C`hash\*(C'\fR.
.SS "fetch_size"
.IX Subsection "fetch_size"
Returns the number of elements of the hash.
.SS "sort"
.IX Subsection "sort"
Sort an ordered hash. Throws an error if called on a non ordered hash.
.SS "insort"
.IX Subsection "insort"
Parameters: key
.PP
Create a new element in the ordered hash while keeping alphabetical order of the keys
.PP
Returns the newly created element.
.PP
Throws an error if called on a non ordered hash.
.SS "firstkey"
.IX Subsection "firstkey"
Returns the first key of the hash. Behaves like \f(CW\*(C`each\*(C'\fR core perl
function.
.SS "nextkey"
.IX Subsection "nextkey"
Returns the next key of the hash. Behaves like \f(CW\*(C`each\*(C'\fR core perl
function.
.SS "swap"
.IX Subsection "swap"
Parameters: \f(CW\*(C`( key1 , key2 )\*(C'\fR
.PP
Swap the order of the 2 keys. Ignored for non ordered hash.
.SS "move"
.IX Subsection "move"
Parameters: \f(CW\*(C`( key1 , key2 )\*(C'\fR
.PP
Rename key1 in key2.
.PP
Also also optional check parameter to disable warning:
.PP
.Vb 1
\& move (\*(Aqfoo\*(Aq,\*(Aqbar\*(Aq, check => \*(Aqno\*(Aq)
.Ve
.SS "move_after"
.IX Subsection "move_after"
Parameters: \f(CW\*(C`( key_to_move [ , after_this_key ] )\*(C'\fR
.PP
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.
.SS "move_up"
.IX Subsection "move_up"
Parameters: \f(CW\*(C`( key )\*(C'\fR
.PP
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.
.SS "move_down"
.IX Subsection "move_down"
Parameters: \f(CW\*(C`( key )\*(C'\fR
.PP
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.
.SS "load_data"
.IX Subsection "load_data"
Parameters: \f(CW\*(C`( data => ( hash_ref | array_ref ) [ , check => ... , ... ])\*(C'\fR
.PP
Load data as a hash ref for standard hash.
.PP
Ordered hash should be loaded with an array ref or with a hash
containing a special \f(CW\*(C`_\|_order\*(C'\fR element. E.g. loaded with either:
.PP
.Vb 1
\&  [ a => \*(Aqfoo\*(Aq, b => \*(Aqbar\*(Aq ]
.Ve
.PP
or
.PP
.Vb 1
\&  { _\|_order => [\*(Aqa\*(Aq,\*(Aqb\*(Aq], b => \*(Aqbar\*(Aq, a => \*(Aqfoo\*(Aq }
.Ve
.PP
\&\f(CW\*(C`_\|_skip_order\*(C'\fR parameter can be used if loading order is not
important:
.PP
.Vb 1
\&  { _\|_skip_order => 1, b => \*(Aqbar\*(Aq, a => \*(Aqfoo\*(Aq}
.Ve
.PP
load_data can also be called with a single ref parameter.
.SS "get_info"
.IX Subsection "get_info"
Returns a list of information related to the hash. See
\&\*(L"get_info\*(R" in Config::Model::Value for more details.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominique Dumont, (ddumont at cpan dot org)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::Model, 
Config::Model::Instance, 
Config::Model::AnyId,
Config::Model::ListId,
Config::Model::Value
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominique Dumont
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2005\-2021 by Dominique Dumont.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU Lesser General Public License, Version 2.1, February 1999
.Ve