info.novatec.testit.webtester.events.browser.TookScreenshotEvent Maven / Gradle / Ivy

package info.novatec.testit.webtester.events.browser;

import static java.lang.String.format;

import java.io.File;
import java.nio.file.Path;

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NonNull;

import info.novatec.testit.webtester.browser.operations.ScreenshotTaker;
import info.novatec.testit.webtester.events.AbstractEvent;
import info.novatec.testit.webtester.events.Event;
import info.novatec.testit.webtester.events.EventListener;
import info.novatec.testit.webtester.events.EventSystem;


/**
 * This {@link Event event} occurs whenever a screenshot was taken.
 * 
 * It includes the file reference to the screenshot as a property.
 *
 * @see Event
 * @see EventListener
 * @see EventSystem
 * @see ScreenshotTaker#takeAndStore()
 * @see ScreenshotTaker#takeAndStore(String)
 * @see ScreenshotTaker#takeAndStore(Path)
 * @see ScreenshotTaker#takeAndStore(File)
 * @see ScreenshotTaker#takeAndStore(String, String)
 * @see ScreenshotTaker#takeAndStore(Path, String)
 * @see ScreenshotTaker#takeAndStore(File, String)
 * @since 2.0
 */
@Getter
@AllArgsConstructor
@SuppressWarnings("serial")
public class TookScreenshotEvent extends AbstractEvent {

    @NonNull
    private final File screenshot;

    @Override
    public String describe() {
        return format("took screenshot and stored it as: '%s'", screenshot);
    }

}