View on
MetaCPAN
Dale Amon > Fault-1.01-2 > Fault::Notepad

Download:
Fault-1.01-2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

 Fault::Notepad - A notepad for random text messages.

SYNOPSIS ^

 use Fault::Notepad;
 $obj  = Fault::Notepad->new;
 $obj  = $obj->add       ($text);
 $obj  = $obj->addObject ($msg);
 $obj  = $obj->merge     ($obj2);
 $obj  = $obj->print;
 $cnt  = $obj->count;
 $obj  = $obj->fprint    ($fh);
 $str  = $obj->sprint;

Inheritance ^

 UNIVERSAL

Description ^

A notepad is a container for random text messages. Notes are added to a list in the sequence recieved and once written are not modifiable.

This is a very early form of the class and it does very little at present other than append Fault::Msg objects to it's internal list and dump text from them on demand.

It is a container for text generated deep in a program which will allow it to be collected and returned to the top level or wherever it may be useful.

Examples ^

 use Fault::Notepad;
 use Fault::Msg;
 my $obj  = Fault::Notepad->new;
 my $obj2 = Fault::Notepad->new;
 my $msg  = Fault::Msg->("abridging freedom of speech...\n");

         $obj->add        ("Congress shall pass no law ");
         $obj2->addObject ($msg);
         $obj->merge      ($obj2);
         $obj->print;

         open $fh, ">notepad.tmp";
         $obj->fprint     ($fh);
         close $fh;

Class Variables ^

 None.

Instance Variables ^

 None.

Class Methods ^

$obj = Fault::Notepad->new

Create instances of Notepad.

Instance Methods ^

$obj = $obj->add ($note)

Append a textual note to the notepad.

$obj = $obj->add ($obj)

Append an Fault::Msg object containing a textual note to the notepad. the current time; if the object has digital signatures, create one.

$cnt = $obj->count

Returns a count of the items on the notepad.

$obj = $obj->fprint ($fh)

Print contents of Notepad verbatim to file.

$obj = $obj->merge ($other)

Append the contents of the argument notepad object to this notepad.

$obj = $obj->print

Print contents of Notepad verbatim to stdout.

$str = $obj->sprint

Print contents of Notepad verbatim to a string.

Private Class Method ^

 None.

Private Instance Methods ^

 None.

Errors and Warnings ^

 None.

KNOWN BUGS ^

 See TODO.

SEE ALSO ^

 Fault::Logger, Fault::Msg.

AUTHOR ^

Dale Amon <amon@vnl.com>

syntax highlighting: