.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "MakeMethods::Evaled::Hash 3pm"
.TH MakeMethods::Evaled::Hash 3pm "2022-10-13" "perl v5.34.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"
Class::MakeMethods::Evaled::Hash \- Typical hash methods
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&  package MyObject;
\&  use Class::MakeMethods::Evaled::Hash (
\&    new => \*(Aqnew\*(Aq,
\&    scalar => [ \*(Aqfoo\*(Aq, \*(Aqbar\*(Aq ],
\&    array => \*(Aqmy_list\*(Aq,
\&    hash => \*(Aqmy_index\*(Aq,
\&  );
\&  ...
\&  
\&  # Constructor
\&  my $obj = MyObject\->new( foo => \*(AqFoozle\*(Aq );
\&  
\&  # Scalar Accessor
\&  print $obj\->foo();
\&  
\&  $obj\->bar(\*(AqBarbados\*(Aq); 
\&  print $obj\->bar();
\&  
\&  # Array accessor
\&  $obj\->my_list(0 => \*(AqFoozle\*(Aq, 1 => \*(AqBang!\*(Aq);
\&  print $obj\->my_list(1);
\&  
\&  # Hash accessor
\&  $obj\->my_index(\*(Aqbroccoli\*(Aq => \*(AqBlah!\*(Aq, \*(Aqfoo\*(Aq => \*(AqFiddle\*(Aq);
\&  print $obj\->my_index(\*(Aqfoo\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Evaled::Hash subclass of MakeMethods provides a simple constructor and accessors for blessed-hash object instances.
.SS "Calling Conventions"
.IX Subsection "Calling Conventions"
When you \f(CW\*(C`use\*(C'\fR this package, the method names you provide
as arguments cause subroutines to be generated and installed in
your module.
.PP
See \*(L"Calling Conventions\*(R" in Class::MakeMethods::Standard for a summary, or \*(L"\s-1USAGE\*(R"\s0 in Class::MakeMethods for full details.
.SS "Declaration Syntax"
.IX Subsection "Declaration Syntax"
To declare methods, pass in pairs of a method-type name followed
by one or more method names. Valid method-type names for this
package are listed in \*(L"\s-1METHOD GENERATOR TYPES\*(R"\s0.
.PP
See \*(L"Declaration Syntax\*(R" in Class::MakeMethods::Standard for more
syntax information.
.SH "METHOD GENERATOR TYPES"
.IX Header "METHOD GENERATOR TYPES"
.SS "new \- Constructor"
.IX Subsection "new - Constructor"
For each method name passed, returns a subroutine with the following characteristics:
.IP "\(bu" 4
If called as a class method, makes a new hash and blesses it into that class.
.IP "\(bu" 4
If called on a hash-based instance, makes a copy of it and blesses the copy into the same class as the original instance.
.IP "\(bu" 4
If passed a list of key-value pairs, appends them to the new hash. These arguments override any copied values, and later arguments with the same name will override earlier ones.
.IP "\(bu" 4
Returns the new instance.
.PP
Sample declaration and usage:
.PP
.Vb 5
\&  package MyObject;
\&  use Class::MakeMethods::Evaled::Hash (
\&    new => \*(Aqnew\*(Aq,
\&  );
\&  ...
\&  
\&  # Bare constructor
\&  my $empty = MyObject\->new();
\&  
\&  # Constructor with initial values
\&  my $obj = MyObject\->new( foo => \*(AqFoozle\*(Aq, bar => \*(AqBarbados\*(Aq );
\&  
\&  # Copy with overriding value
\&  my $copy = $obj\->new( bar => \*(AqBob\*(Aq );
.Ve
.SS "scalar \- Instance Accessor"
.IX Subsection "scalar - Instance Accessor"
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
.IP "\(bu" 4
Must be called on a hash-based instance.
.IP "\(bu" 4
Uses the method name as a hash key to access the related value for each instance.
.IP "\(bu" 4
If called without any arguments returns the current value.
.IP "\(bu" 4
If called with an argument, stores that as the value, and returns it,
.PP
Sample declaration and usage:
.PP
.Vb 5
\&  package MyObject;
\&  use Class::MakeMethods::Evaled::Hash (
\&    scalar => \*(Aqfoo\*(Aq,
\&  );
\&  ...
\&  
\&  # Store value
\&  $obj\->foo(\*(AqFoozle\*(Aq);
\&  
\&  # Retrieve value
\&  print $obj\->foo;
.Ve
.SS "array \- Instance Ref Accessor"
.IX Subsection "array - Instance Ref Accessor"
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
.IP "\(bu" 4
Must be called on a hash-based instance.
.IP "\(bu" 4
Uses the method name as a hash key to access the related value for each instance.
.IP "\(bu" 4
The value for each instance will be a reference to an array (or undef).
.IP "\(bu" 4
If called without any arguments, returns the current array-ref value (or undef).
.IP "\(bu" 4
If called with one argument, uses that argument as an index to retrieve from the referenced array, and returns that value (or undef).
.IP "\(bu" 4
If called with a list of index-value pairs, stores the value at the given index in the referenced array. If the instance's value was previously undefined, a new array is autovivified. The current value in each position will be overwritten, and later arguments with the same index will override earlier ones. Returns the current array-ref value.
.PP
Sample declaration and usage:
.PP
.Vb 5
\&  package MyObject;
\&  use Class::MakeMethods::Evaled::Hash (
\&    array => \*(Aqbar\*(Aq,
\&  );
\&  ...
\&  
\&  # Set values by position
\&  $obj\->bar(0 => \*(AqFoozle\*(Aq, 1 => \*(AqBang!\*(Aq);
\&  
\&  # Positions may be overwritten, and in any order
\&  $obj\->bar(2 => \*(AqAnd Mash\*(Aq, 1 => \*(AqBlah!\*(Aq);
\&  
\&  # Retrieve value by position
\&  print $obj\->bar(1);
\&    
\&  # Direct access to referenced array
\&  print scalar @{ $obj\->bar() };
\&  
\&  # Reset the array contents to empty
\&  @{ $obj\->bar() } = ();
.Ve
.SS "hash \- Instance Ref Accessor"
.IX Subsection "hash - Instance Ref Accessor"
For each method name passed, uses a closure to generate a subroutine with the following characteristics:
.IP "\(bu" 4
Must be called on a hash-based instance.
.IP "\(bu" 4
Uses the method name as a hash key to access the related value for each instance.
.IP "\(bu" 4
The value for each instance will be a reference to a hash (or undef).
.IP "\(bu" 4
If called without any arguments, returns the current hash-ref value (or undef).
.IP "\(bu" 4
If called with one argument, uses that argument as an index to retrieve from the referenced hash, and returns that value (or undef).
.IP "\(bu" 4
If called with a list of key-value pairs, stores the value under the given key in the referenced hash. If the instance's value was previously undefined, a new hash is autovivified. The current value under each key will be overwritten, and later arguments with the same key will override earlier ones. Returns the current hash-ref value.
.PP
Sample declaration and usage:
.PP
.Vb 5
\&  package MyObject;
\&  use Class::MakeMethods::Evaled::Hash (
\&    hash => \*(Aqbaz\*(Aq,
\&  );
\&  ...
\&  
\&  # Set values by key
\&  $obj\->baz(\*(Aqfoo\*(Aq => \*(AqFoozle\*(Aq, \*(Aqbar\*(Aq => \*(AqBang!\*(Aq);
\&  
\&  # Values may be overwritten, and in any order
\&  $obj\->baz(\*(Aqbroccoli\*(Aq => \*(AqBlah!\*(Aq, \*(Aqfoo\*(Aq => \*(AqFiddle\*(Aq);
\&  
\&  # Retrieve value by key
\&  print $obj\->baz(\*(Aqfoo\*(Aq);
\&  
\&  # Direct access to referenced hash
\&  print keys %{ $obj\->baz() };
\&  
\&  # Reset the hash contents to empty
\&  @{ $obj\->baz() } = ();
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See Class::MakeMethods for general information about this distribution.
.PP
See Class::MakeMethods::Evaled for more about this family of subclasses.