The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

App::JobLog::Log::Line - encapsulates one line of log text

VERSION

version 1.042

DESCRIPTION

App::JobLog::Log::Line encapsulates a line of text from the log -- the semantics of such a line and the code required to construct, parse, or serialize it.

METHODS

new

For composing a log line out of a hash of attributes.

parse

For parsing a line in an existing log. Expects string to parse as an argument.

clone

Produces an object semantically identical to that on which it was invoked but stored without shared references so changes to the latter will not effect the former.

to_string

Serializes object to the string that would represent it in a log.

time_stamp

Represents optional DateTime object in the format used in the log. If no argument is provided, the timestamp of the line itself is returned.

text

Accessor to text attribute of line, if any. Should only be defined for well formed log lines. Is lvalue.

tags

Accessor to array reference containing tags, if any. Is lvalue.

comment

Accessor to comment value, if any. Should only be defined for comment lines. Is lvalue.

time

Accessor to time value, if any. Should only be defined for event lines. Lvalue.

description

Accessor to reference to description list. Should only be defined for lines describing the beginning of an event. Lvalue.

Whether lines is malformed.

is_beginning

Whether line describes the beginning of an event.

is_end

Whether line only defines the end of an event.

is_note

Whether the line is a note rather than a terminus of an event or a comment or blank line.

is_event

Whether line has a time stamp.

is_endpoint

Whether the line has a timestamp marking the beginning or end of a logged interval.

is_comment

Whether line represents a comment in the log.

tags_unspecified

Whether object was constructed from a hash of values that contained no tags key.

is_blank

Whether object represents a blank line in the log.

comment_out

Convert this into a comment line.

all_tags

Expects list of tags. Returns whether all tags in list are present in object.

exists_tag

Expects list of tags. Returns whether any member of list is among tags of object.

AUTHOR

David F. Houghton <dfhoughton@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by David F. Houghton.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.