org.assertj.swing.image.ImageFileWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of assertj-swing Show documentation

Assertj-Swing test framework

The newest version!

/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * Copyright 2012-2018 the original author or authors.
 */
package org.assertj.swing.image;

import static org.assertj.core.util.Files.newFile;
import static org.assertj.swing.image.ImageFileExtensions.PNG;

import java.awt.image.BufferedImage;
import java.io.IOException;

import org.jetbrains.annotations.NotNull;
import javax.imageio.ImageIO;

/**
 * Writes an image as a file in the file system.
 * 
 * @author Alex Ruiz
 */
public class ImageFileWriter {
  /**
   * Writes an image as a PNG file to the file system. If there is already a {@code File} present, its contents are
   * discarded.
   * 
   * @param image a {@code BufferedImage} to be written.
   * @param filePath the path of the image file to create.
   * @return {@code false} if the image could not be saved.
   * @exception IOException if an error occurs during writing.
   */
  public boolean writeAsPng(@NotNull BufferedImage image, @NotNull String filePath) throws IOException {
    return ImageIO.write(image, PNG, newFile(filePath));
  }
}