io.github.astrapi69.file.write.StoreFileExtensions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of file-worker Show documentation
Project that provides utility classes for file operations
There is a newer version: 19.0
/**
 * The MIT License
 *
 * Copyright (C) 2015 Asterios Raptis
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package io.github.astrapi69.file.write;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.nio.charset.Charset;
import java.util.Optional;

import io.github.astrapi69.string.CharsetExtensions;

/**
 * The class {@link StoreFileExtensions} provides extension methods for files to store or update
 *
 * @author Asterios Raptis
 */
public final class StoreFileExtensions
{


	private StoreFileExtensions()
	{
	}

	/**
	 * Stores the given byte array to the given {@link File} object
	 *
	 * @param file
	 *            The {@link File} object to write the given byte array
	 * @param data
	 *            The byte array to be store
	 * @throws IOException
	 *             Signals that an I/O exception has occurred
	 */
	public static void toFile(final File file, final byte[] data) throws IOException
	{
		try (FileOutputStream fos = new FileOutputStream(file);
			BufferedOutputStream bos = new BufferedOutputStream(fos))
		{
			bos.write(data);
			bos.flush();
		}
	}

	/**
	 * This Method writes the given {@link String} object to the given {@link File} object
	 *
	 * @param file
	 *            The {@link File} object to write the given {@link String} object
	 * @param stringToWrite
	 *            The {@link String} object to write into the given {@link File} object
	 * @return true if given {@link String} object was written successfully to the given
	 *         {@link File} object otherwise false
	 * @throws FileNotFoundException
	 *             is thrown if an attempt to open the file denoted by a specified pathname has
	 *             failed
	 * @throws IOException
	 *             Signals that an I/O exception has occurred
	 */
	public static boolean toFile(final File file, final String stringToWrite)
		throws FileNotFoundException, IOException
	{
		return toFile(file, stringToWrite, (String)null);
	}

	/**
	 * This Method writes the given {@link String} object to the given {@link File} object with the
	 * given encoding as {@link String} object
	 *
	 * @param file
	 *            The {@link File} object to write the given {@link String} object
	 * @param stringToWrite
	 *            The {@link String} object to write into the given {@link File} object
	 * @param encoding
	 *            The encoding from the file as {@link String} object
	 * @return true if given {@link String} object was written successfully to the given
	 *         {@link File} object otherwise false
	 * @throws FileNotFoundException
	 *             is thrown if an attempt to open the file denoted by a specified pathname has
	 *             failed
	 * @throws IOException
	 *             Signals that an I/O exception has occurred
	 */
	public static boolean toFile(final File file, final String stringToWrite, final String encoding)
		throws FileNotFoundException, IOException
	{
		Optional optionalCharset = CharsetExtensions.getCharset(encoding);

		return optionalCharset.isPresent()
			? toFile(file, stringToWrite, optionalCharset.get())
			: toFile(file, stringToWrite, (Charset)null);
	}

	/**
	 * This Method writes the given {@link String} object to the given {@link File} object with the
	 * encoding that is encapsulated in the given {@link Charset} object
	 *
	 * @param file
	 *            The {@link File} object to write the given {@link String} object
	 * @param stringToWrite
	 *            The {@link String} object to write into the given {@link File} object
	 * @param charset
	 *            The charset from the file.
	 * @return true if given {@link String} object was written successfully to the given
	 *         {@link File} object otherwise false
	 * @throws FileNotFoundException
	 *             is thrown if an attempt to open the file denoted by a specified pathname has
	 *             failed
	 * @throws IOException
	 *             Signals that an I/O exception has occurred
	 */
	public static boolean toFile(final File file, final String stringToWrite, final Charset charset)
		throws FileNotFoundException, IOException
	{
		boolean written = false;
		try (FileOutputStream fos = new FileOutputStream(file);
			BufferedOutputStream bos = new BufferedOutputStream(fos);
			OutputStreamWriter osw = (null == charset)
				? new OutputStreamWriter(bos)
				: new OutputStreamWriter(bos, charset);
			PrintWriter printWriter = new PrintWriter(osw))
		{
			printWriter.write(stringToWrite);
			written = true;
		}
		return written;
	}

}