com.github.powerlibraries.io.functions.OutputStreamWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iopower Show documentation

Power Libraries is a small project to collect some repeatedly needed or otherwise useful Java 8 classes in a collection of tiny libraries. IO Power is the first and really tiny library of the Power Libraries. It contains some simple helper method for opening Input- and Outputstreams. The main purpose of IO Power is to make opening streams, readers and writers less cluttered and simple to understand.

There is a newer version: 1.1.3

Show newest version

package com.github.powerlibraries.io.functions;

import java.io.IOException;
import java.io.OutputStream;

/**This class is a simple functional interface used to wrap an OutputStream with another. Instead of implementing this 
 * interface it is often enough to use a constructor, e.g. BufferedOutputStream::new.
 * 
 * @author Manuel Hegner
 */
@FunctionalInterface
public interface OutputStreamWrapper {
	
	/**
	 * This method should wrap the given OutputStream out with another OutputStream (e.g. compression) and return it.
	 * @param out the stream given
	 * @return a wrapped OutputStream
	 * @throws IOException thrown by some OutputStream constructors
	 */
	public OutputStream wrap(OutputStream out) throws IOException;
}