.\" 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
.\" ========================================================================
.\"
.IX Title "Text::BibTeX::Validate::Warning 3pm"
.TH Text::BibTeX::Validate::Warning 3pm "2021-02-28" "perl v5.32.1" "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"
Text::BibTeX::Validate::Warning \- validaton warning class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Text::BibTeX::Validate::Warning;
\&
\&    my $warning = Text::BibTeX::Validate::Warning\->new(
\&        \*(Aqvalue \e\*(Aq%(value)s\e\*(Aq is better written as \e\*(Aq%(suggestion)s\e\*(Aq\*(Aq,
\&        {
\&            field => \*(Aqmonth\*(Aq,
\&            value => \*(Aq1\*(Aq,
\&            suggestion => \*(AqJan\*(Aq,
\&        }
\&    );
\&    print STDERR "$warning\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Text::BibTeX::Validate::Warning is used to store the content of
validation warning (as emitted by
Text::BibTeX::Validate) in a structured way.
Overloads are defined to stringify and to compare instances of the
class.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "new( $message, $fields )"
.el .SS "new( \f(CW$message\fP, \f(CW$fields\fP )"
.IX Subsection "new( $message, $fields )"
Takes Text::sprintfn\-compatible template and a hash
with the values for replacement in the template. Three field names are
reserved and used as prefixes for messages if defined: \f(CW\*(C`file\*(C'\fR for the
name of a file, \f(CW\*(C`key\*(C'\fR for BibTeX key and \f(CW\*(C`field\*(C'\fR for BibTeX field
name. Field \f(CW\*(C`suggestion\*(C'\fR is also somewhat special, as
Text::BibTeX::Validate may use its value to
replace the original in an attempt to clean up the BibTeX entry.
.SS "\fBfields()\fP"
.IX Subsection "fields()"
Returns an array of fields defined in the instance in any order.
.ie n .SS "get( $field )"
.el .SS "get( \f(CW$field\fP )"
.IX Subsection "get( $field )"
Returns value of a field.
.ie n .SS "set( $field, $value )"
.el .SS "set( \f(CW$field\fP, \f(CW$value\fP )"
.IX Subsection "set( $field, $value )"
Sets a new value for a field. Returns the old value.
.ie n .SS "delete( $field )"
.el .SS "delete( \f(CW$field\fP )"
.IX Subsection "delete( $field )"
Unsets value for a field. Returns the old value.
.SS "\fBto_string()\fP"
.IX Subsection "to_string()"
Return a string representing the warning.
.SH "AUTHORS"
.IX Header "AUTHORS"
Andrius Merkys, <merkys@cpan.org>