org.assertj.swing.image

Class ScreenshotTaker

java.lang.Object

org.assertj.swing.image.ScreenshotTaker

public class ScreenshotTaker
extends Object

Takes screenshots of the desktop and AWT or Swing Components.

Author:

Alex Ruiz, Yvonne Wang

Constructor Summary

Constructors

Constructor and Description
ScreenshotTaker() Creates a new ScreenshotTaker.

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScreenshotTaker

public ScreenshotTaker()

Creates a new ScreenshotTaker.

Throws:

ImageException - if an AWT Robot (the responsible for taking screenshots) cannot be instantiated.

Method Detail

saveDesktopAsPng

public 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

public BufferedImage takeDesktopScreenshot()

Takes a screenshot of the desktop.

Returns:

the screenshot of the desktop.

Throws:

SecurityException - if readDisplayPixels permission is not granted.

saveComponentAsPng

public void saveComponentAsPng(@Nonnull
                      Component c,
                      @Nonnull
                      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

@Nonnull
public BufferedImage takeScreenshotOf(@Nonnull
                                     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

public void saveImage(@Nonnull
             BufferedImage image,
             @Nonnull
             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.