de.ppi.selenium.logevent.api.EventLogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webtest Show documentation
Some additional helper for webtesting with selenium
There is a newer version: 0.12
package de.ppi.selenium.logevent.api;

import org.openqa.selenium.WebDriver;

/**
 * Object to log events.
 *
 */
public interface EventLogger {

    /**
     * Log an assertion-error, with a screenshot. Priority is always
     * {@link Priority#FAILURE}.
     *
     * @param assertionError the assertionError.
     */
    void logAssertionError(AssertionError assertionError);

    /**
     * Define that the log should be done with screenshot if priority higher
     * then the threshold.
     *
     * @param prio priority for the screenshot.
     * @param webDriver the webdriver.
     * @return the EventLogger.
     */
    EventLogger withScreenshot(Priority prio, WebDriver webDriver);

    /**
     * Logs the event.
     *
     * @param action the action @see {@link EventActions}.
     * @param message the message.
     */
    void log(String action, String message);

    /**
     * Logs the event.
     *
     * @param action the action @see {@link EventActions}.
     * @param message the message.
     * @param argument1 argument 1 for the message.
     */
    void log(String action, String message, Object argument1);

    /**
     * Logs the event.
     *
     * @param action the action @see {@link EventActions}.
     * @param message the message.
     * @param argument1 argument 1 for the message.
     * @param argument2 argument 2 for the message.
     */
    void log(String action, String message, Object argument1, Object argument2);

    /**
     * Logs the event.
     *
     * @param action the action @see {@link EventActions}.
     * @param message the message.
     * @param argument1 argument 1 for the message.
     * @param argument2 argument 2 for the message.
     * @param argument3 argument 3 for the message.
     */
    void log(String action, String message, Object argument1, Object argument2,
            Object argument3);

    /**
     * Logs the event.
     *
     * @param action the action @see {@link EventActions}.
     * @param message the message.
     * @param argument1 argument 1 for the message.
     * @param argument2 argument 2 for the message.
     * @param argument3 argument 3 for the message.
     * @param argument4 argument 4 for the message.
     */
    void log(String action, String message, Object argument1, Object argument2,
            Object argument3, Object argument4);

    /**
     * Return if a message will be logged.
     *
     * @return true if a message will be logged.
     */
    boolean willLogged();

    /**
     * Return if a screenshot will created.
     *
     * @param priority the priority which with the screenshot should be created.
     * @return true a screenshot will created.
     */
    boolean willScreenshotLogged(Priority priority);
}