org.assertj.swing.image

Interface ScreenshotTakerIF

All Known Implementing Classes:

NoopScreenshotTaker, ScreenshotTaker

public interface ScreenshotTakerIF

Author:

Carsten Behring

Method Summary

Modifier and Type	Method and Description
void	saveComponentAsPng(Component c, String imageFilePath) Takes a screenshot of the given AWT or Swing Component and saves it as a PNG file.
void	saveDesktopAsPng(String imageFilePath) Takes a screenshot of the desktop and saves it as a PNG file.
void	saveImage(BufferedImage image, String filePath) Saves the given image as a PNG file.
BufferedImage	takeDesktopScreenshot() Takes a screenshot of the desktop.
BufferedImage	takeScreenshotOf(Component c) Takes a screenshot of the given AWT or Swing Component.

Method Detail

saveDesktopAsPng

void saveDesktopAsPng(String imageFilePath)

Takes a screenshot of the desktop and saves it as a PNG file.

Parameters:

imageFilePath - the path of the file to save the screenshot to.

Throws:

NullPointerException - if the given file path is null.

IllegalArgumentException - if the given file path is empty.

IllegalArgumentException - if the given file path does not end with ".png".

IllegalArgumentException - if the given file path belongs to a non-empty directory.

IORuntimeException - if an I/O error prevents the image from being saved as a file.

takeDesktopScreenshot

BufferedImage takeDesktopScreenshot()

Takes a screenshot of the desktop.

Returns:

the screenshot of the desktop.

Throws:

SecurityException - if readDisplayPixels permission is not granted.

saveComponentAsPng

void saveComponentAsPng(Component c,
                        String imageFilePath)

Takes a screenshot of the given AWT or Swing Component and saves it as a PNG file.

Parameters:

c - the given Component.

imageFilePath - the path of the file to save the screenshot to.

Throws:

NullPointerException - if the given file path is null.

IllegalArgumentException - if the given file path is empty.

IllegalArgumentException - if the given file path does not end with ".png".

IllegalArgumentException - if the given file path belongs to a non-empty directory.

IORuntimeException - if an I/O error prevents the image from being saved as a file.

takeScreenshotOf

BufferedImage takeScreenshotOf(Component c)

Takes a screenshot of the given AWT or Swing Component.

Parameters:

c - the given Component.

Returns:

a screenshot of the given Component.

Throws:

SecurityException - if readDisplayPixels permission is not granted.

saveImage

void saveImage(BufferedImage image,
               String filePath)

Saves the given image as a PNG file.

Parameters:

image - the image to save.

filePath - the path of the file to save the image to.

Throws:

NullPointerException - if the given file path is null.

IllegalArgumentException - if the given file path is empty.

IllegalArgumentException - if the given file path does not end with ".png".

IllegalArgumentException - if the given file path belongs to a non-empty directory.

IORuntimeException - if an I/O error prevents the image from being saved as a file.