lucee.runtime.util.IO Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lucee Show documentation
Building the Lucee Loader JAR
There is a newer version: 6.2.0.164-RC
/**
 * Copyright (c) 2015, Lucee Association Switzerland. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either 
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see .
 * 
 */
package lucee.runtime.util;

import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.nio.charset.Charset;

import lucee.commons.io.res.Resource;

public interface IO {
	/**
	 * close stream silently (no Exception)
	 * 
	 * @param is Input Stream
	 */
	public void closeSilent(InputStream is);

	/**
	 * close stream silently (no Exception)
	 * 
	 * @param os Output Stream
	 */
	public void closeSilent(OutputStream os);

	/**
	 * close streams silently (no Exception)
	 * 
	 * @param is Input Stream
	 * @param os Output Stream
	 */
	public void closeSilent(InputStream is, OutputStream os);

	/**
	 * close streams silently (no Exception)
	 * 
	 * @param r Reader
	 */
	public void closeSilent(Reader r);

	/**
	 * close streams silently (no Exception)
	 * 
	 * @param w Writer
	 */
	public void closeSilent(Writer w);

	/**
	 * close any object with a close method silently
	 * 
	 * @param o Object
	 */
	public void closeSilent(Object o);

	/**
	 * converts an InputStream to a String
	 * 
	 * @param is Input Stream
	 * @param charset Charset
	 * @return Returns the Content.
	 * @throws IOException IO Exception
	 */
	public String toString(InputStream is, Charset charset) throws IOException;

	/**
	 * reads the content of a Resource
	 * 
	 * @param res Resource
	 * @param charset Charset
	 * @return Returns the Content.
	 * @throws IOException IO Exception
	 */
	public String toString(Resource res, Charset charset) throws IOException;

	/**
	 * converts a Byte Array to a String
	 * 
	 * @param barr Byte Array
	 * @param charset Charset
	 * @return Returns the Content.
	 * @throws IOException IO Exception
	 */
	public String toString(byte[] barr, Charset charset) throws IOException;

	/**
	 * reads Readers data as String
	 * 
	 * @param r Reader
	 * @return Returns the Content.
	 * @throws IOException IO Exception
	 */
	public String toString(Reader r) throws IOException;

	/**
	 * copy data from Input Stream to Output Stream
	 * 
	 * @param in Input stream
	 * @param out Output stream
	 * @param closeIS close Input Stream when done
	 * @param closeOS close Output Stream when done
	 * @throws IOException IO Exception
	 */
	public void copy(InputStream in, OutputStream out, boolean closeIS, boolean closeOS) throws IOException;

	/**
	 * copy data from Reader to Writer
	 * 
	 * @param in Input stream
	 * @param out Output stream
	 * @param closeR close the Reader when done
	 * @param closeW close the Writer when done
	 * @throws IOException IO Exception
	 */
	public void copy(Reader in, Writer out, boolean closeR, boolean closeW) throws IOException;

	/**
	 * copy content from Source to Target
	 * 
	 * @param src Source
	 * @param trg Target
	 * @throws IOException IO Exception
	 */
	public void copy(Resource src, Resource trg) throws IOException;

	public BufferedInputStream toBufferedInputStream(InputStream is);

	public BufferedOutputStream toBufferedOutputStream(OutputStream os);

	public void write(Resource res, String content, boolean append, Charset charset) throws IOException;

	public void write(Resource res, byte[] content, boolean append) throws IOException;

	public Reader getReader(InputStream is, Charset charset) throws IOException;

	public Reader getReader(Resource res, Charset charset) throws IOException;

	public Reader toBufferedReader(Reader reader);

	public void copy(InputStream is, Resource out, boolean closeIS) throws IOException;

	public OutputStream createTemporaryStream();

}