Richard Munroe > StanzaFile > Stanza

Download:
stanzafile/StanzaFile-1.05.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.02   Source  

NAME ^

Stanza - Container for holding data parsed from stanza files.

SYNOPSIS ^

    # Instantiate or clone a copy of a stanza.
    #
    my $theStanza = new Stanza('Stanza Name') ;

    # Add a datum to a Stanza.
    #
    $theStanza->add('newDatum', 'value') ;

    # Fetch or store an item in a Stanza.
    #
    my $theOldValue = $theStanza->item('newDatum') ;
    $theStanza->item('newDatum', 'newValue') ;

    # Merge the contents of two stanzas.
    #
    $theNewStanza->merge($theOldStanza) ;

    # Get/set the name of the stanza.
    #
    $theStanza->name() ;
    $theStanza->name('newName') ;

    # Get the order in which data were added to the stanza.
    #
    foreach ($theStanza->order())
    {
        ... ;
    } ;

DESCRIPTION ^

The Stanza class provides a syntax free container for holding stanza datum/value pairs. As a consequence, StanzaFile formatting must be done in the classes using the Stanza class, not by the Stanza class or sub-classes thereof.

EXAMPLES ^

BUGS ^

None known.

WARNINGS ^

AUTHOR ^

Dick Munroe (munroe@csworks). I'm looking for work. If you hear of anything that might be of interest to a VERY senior engineer/architect drop me a note. See http://www.acornsw.com/resume/dick.html for details.

SEE ALSO ^

syntax highlighting: