­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" 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 "NullLogLite 3" .TH NullLogLite 3 "2002-09-24" "perl v5.26.3" "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" Log::NullLogLite \- The "Log::NullLogLite" class implements the Null Object pattern for the "Log::LogLite" class. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Log::NullLogLite; \& \& # create new Log::NullLogLite object \& my $log = new Log::NullLogLite(); \& \& ... \& \& # we had an error (this entry will not be written to the log \& # file because we use Log::NullLogLite object). \& $log\->write("Could not open the file ".$file_name.": $!", 4); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \f(CW\*(C`Log::NullLogLite\*(C'\fR class is derived from the \f(CW\*(C`Log::LogLite\*(C'\fR class and implement the Null Object Pattern to let us to use the \f(CW\*(C`Log::LogLite\*(C'\fR class with \fBnull\fR \f(CW\*(C`Log::LogLite\*(C'\fR objects. We might want to do that if we use a \f(CW\*(C`Log::LogLite\*(C'\fR object in our code, and we do not want always to actually define a \f(CW\*(C`Log::LogLite\*(C'\fR object (i.e. not always we want to write to a log file). In such a case we will create a \&\f(CW\*(C`Log::NullLogLite\*(C'\fR object instead of the \f(CW\*(C`Log::LogLite\*(C'\fR object, and will use that object instead. The object has all the methods that the \f(CW\*(C`Log::LogLite\*(C'\fR object has, but those methods do nothing. Thus our code will continue to run without any change, yet we will not have to define a log file path for the \&\f(CW\*(C`Log::LogLite\*(C'\fR object, and no log will be created. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .IP "new ( \s-1FILEPATH\s0 [,LEVEL [,DEFAULT_MESSAGE ]] )" 4 .IX Item "new ( FILEPATH [,LEVEL [,DEFAULT_MESSAGE ]] )" The constructor. The parameters will not have any affect. Returns the new Log::NullLogLite object. .SH "METHODS" .IX Header "METHODS" .IP "write( \s-1MESSAGE\s0 [, \s-1LEVEL\s0 ] )" 4 .IX Item "write( MESSAGE [, LEVEL ] )" Does nothing. The parameters will not have any affect. Returns nothing. .IP "level( [ \s-1LEVEL\s0 ] )" 4 .IX Item "level( [ LEVEL ] )" Does nothing. The parameters will not have any affect. Returns \-1. .IP "default_message( [ \s-1MESSAGE\s0 ] )" 4 .IX Item "default_message( [ MESSAGE ] )" Does nothing. The parameters will not have any affect. Returns empty string (""). .SH "AUTHOR" .IX Header "AUTHOR" Rani Pinchuk, rani@cpan.org .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2001\-2002 Ockham Technology N.V. & Rani Pinchuk. All rights reserved. This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBLog::LogLite\fR\|(3), The Null Object Pattern \- Bobby Woolf \- PLoP96 \- published in Pattern Languages of Program Design 3 (http://cseng.aw.com/book/0,,0201310112,00.html) .SH "POD ERRORS" .IX Header "POD ERRORS" Hey! \fBThe above document had some coding errors, which are explained below:\fR .IP "Around line 128:" 4 .IX Item "Around line 128:" You forgot a '=back' before '=head1'