de.ppi.selenium.logevent.api

Interface EventLogger

All Known Implementing Classes:

EmptyLogger, EventLoggerImpl, EventLoggerRule

public interface EventLogger

Object to log events.

Method Summary

Modifier and Type	Method and Description
void	log(java.lang.String action, java.lang.String message) Logs the event.
void	log(java.lang.String action, java.lang.String message, java.lang.Object argument1) Logs the event.
void	log(java.lang.String action, java.lang.String message, java.lang.Object argument1, java.lang.Object argument2) Logs the event.
void	log(java.lang.String action, java.lang.String message, java.lang.Object argument1, java.lang.Object argument2, java.lang.Object argument3) Logs the event.
void	log(java.lang.String action, java.lang.String message, java.lang.Object argument1, java.lang.Object argument2, java.lang.Object argument3, java.lang.Object argument4) Logs the event.
void	logAssertionError(java.lang.AssertionError assertionError) Log an assertion-error, with a screenshot.
void	logThrowable(java.lang.Throwable exception) Log an exception, with a screenshot.
boolean	willLogged() Return if a message will be logged.
boolean	willScreenshotLogged(Priority priority) Return if a screenshot will created.
EventLogger	withScreenshot(Priority prio, org.openqa.selenium.WebDriver webDriver) Define that the log should be done with screenshot if priority higher then the threshold.

Method Detail

logAssertionError

void logAssertionError(java.lang.AssertionError assertionError)

Log an assertion-error, with a screenshot. Priority is always Priority.FAILURE.

Parameters:

assertionError - the assertionError.

logThrowable

void logThrowable(java.lang.Throwable exception)

Log an exception, with a screenshot. Priority is always Priority.EXCEPTION.

Parameters:

exception - the exception.

withScreenshot

EventLogger withScreenshot(Priority prio,
                           org.openqa.selenium.WebDriver webDriver)

Define that the log should be done with screenshot if priority higher then the threshold.

Parameters:

prio - priority for the screenshot.

webDriver - the webdriver.

Returns:

the EventLogger.

log

void log(java.lang.String action,
         java.lang.String message)

Logs the event.

Parameters:

action - the action @see EventActions.

message - the message.

log

void log(java.lang.String action,
         java.lang.String message,
         java.lang.Object argument1)

Logs the event.

Parameters:

action - the action @see EventActions.

message - the message.

argument1 - argument 1 for the message.

log

void log(java.lang.String action,
         java.lang.String message,
         java.lang.Object argument1,
         java.lang.Object argument2)

Logs the event.

Parameters:

action - the action @see EventActions.

message - the message.

argument1 - argument 1 for the message.

argument2 - argument 2 for the message.

log

void log(java.lang.String action,
         java.lang.String message,
         java.lang.Object argument1,
         java.lang.Object argument2,
         java.lang.Object argument3)

Logs the event.

Parameters:

action - the action @see EventActions.

message - the message.

argument1 - argument 1 for the message.

argument2 - argument 2 for the message.

argument3 - argument 3 for the message.

log

void log(java.lang.String action,
         java.lang.String message,
         java.lang.Object argument1,
         java.lang.Object argument2,
         java.lang.Object argument3,
         java.lang.Object argument4)

Logs the event.

Parameters:

action - the action @see EventActions.

message - the message.

argument1 - argument 1 for the message.

argument2 - argument 2 for the message.

argument3 - argument 3 for the message.

argument4 - argument 4 for the message.

willLogged

boolean willLogged()

Return if a message will be logged.

Returns:

true if a message will be logged.

willScreenshotLogged

boolean willScreenshotLogged(Priority priority)

Return if a screenshot will created.

Parameters:

priority - the priority which with the screenshot should be created.

Returns:

true a screenshot will created.