.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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::Template::Hash 3pm"
.TH MakeMethods::Template::Hash 3pm "2016-06-10" "perl v5.22.2" "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::Template::Hash \- Method interfaces for hash\-based objects
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&  package MyObject;
\&  use Class::MakeMethods::Template::Hash (
\&    new             => [ \*(Aqnew\*(Aq ],
\&    scalar          => [ \*(Aqfoo\*(Aq, \*(Aqbar\*(Aq ]
\&  );
\&  
\&  package main;
\&
\&  my $obj = MyObject\->new( foo => "Foozle", bar => "Bozzle" );
\&  print $obj\->foo();
\&  $obj\->bar("Bamboozle");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
These meta-methods create and access values within blessed hash objects.
.PP
\&\fBCommon Parameters\fR: The following parameters are defined for Hash meta-methods.
.IP "hash_key" 4
.IX Item "hash_key"
The hash key to use when retrieving values from each hash instance. Defaults to '*', the name of the meta-method.
.Sp
Changing this allows you to change an accessor method name to something other than the name of the hash key used to retrieve its value.
.Sp
Note that this parameter is not portable to the other implementations, such as Global or InsideOut.
.Sp
You can take advantage of parameter expansion to define methods whose hash key is composed of the defining package's name and the individual method name, such as \f(CW\*(C`$self\->{\f(CIMyObject\f(CW\-\f(CIfoo\f(CW}\*(C'\fR:
.Sp
.Vb 1
\&      \*(Aqhash_key\*(Aq => \*(Aq*{target_class}\-*{name}\*(Aq
.Ve
.PP
\&\fBCommon Behaviors\fR
.IP "Behavior: delete" 4
.IX Item "Behavior: delete"
Deletes the named key and associated value from the current hash instance.
.SS "Standard Methods"
.IX Subsection "Standard Methods"
The following methods from Generic are all supported:
.PP
.Vb 10
\&  new
\&  scalar
\&  string
\&  string_index
\&  number 
\&  boolean
\&  bits (*)
\&  array
\&  hash
\&  tiedhash
\&  hash_of_arrays
\&  object
\&  instance
\&  array_of_objects
\&  code
\&  code_or_scalar
.Ve
.PP
See Class::MakeMethods::Template::Generic for the interfaces and behaviors of these method types.
.PP
The items marked with a * above are specifically defined in this package, whereas the others are formed automatically by the interaction of this package's generic settings with the code templates provided by the Generic superclass.
.SS "struct"
.IX Subsection "struct"
.Vb 1
\&  struct => [ qw / foo bar baz / ];
.Ve
.PP
Creates methods for setting, checking and clearing values which
are stored by position in an array. All the slots created with this
meta-method are stored in a single array.
.PP
The argument to struct should be a string or a reference to an
array of strings. For each string meta-method x, it defines two
methods: \fIx\fR and \fIclear_x\fR. x returns the value of the x\-slot.
If called with an argument, it first sets the x\-slot to the argument.
clear_x sets the slot to undef.
.PP
Additionally, struct defines three class method: \fIstruct\fR, which returns
a list of all of the struct values, \fIstruct_fields\fR, which returns
a list of all the slots by name, and \fIstruct_dump\fR, which returns a hash of
the slot\-name/slot\-value pairs.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See Class::MakeMethods for general information about this distribution.
.PP
See Class::MakeMethods::Template for more about this family of subclasses.
.PP
See Class::MakeMethods::Template::Generic for information about the various accessor interfaces subclassed herein.