Claes Jakobsson > Module-Checkstyle-0.04 > Module::Checkstyle::Problem

Download:
Module-Checkstyle-0.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Source  

NAME ^

Module::Checkstyle::Problem - Represents a checkstyle violation

SYNOPSIS ^

    use Module::Checkstyle::Problem;

    my $problem = Module::Checkstyle::Problem->new('warn',
                                                   q(bad variable name '$java'),
                                                   40,
                                                   'my_script.pl');

DESCRIPTION ^

METHODS ^

new ($severity, $message, $line, $file)

Constructs a new Module::Checkstyle::Problem object. $severity should be any of error or warn but others may be specified. $message should be a description of the violated check. $line may either be a scalar or a reference to an array where it will use the first element as line. $file should be the path to the file that violates the check.

get_severity

Returns the severity of the problem.

get_message

Returns the description of the problem.

get_line

Returns the line where the problem was found.

get_file

Returns the file that caused the problem.

as_string

Returns a stringified message combining severity, message, line and file if they are present.

SEE ALSO ^

Module::Checkstyle

syntax highlighting: