com.gc.iotools.stream.writer.CloseShieldWriter Maven / Gradle / Ivy

Go to download

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

EasyStream is a small set of utilities for dealing with streams (InputStreams and OutputStreams). The aim is to ease the use of pipes when they're required. Main features are: * "Convert" an OutputStream to an InputStream. * Count the number of bytes read or wrote to a given stream. * While reading the data from an InputStream copy it to a supplied OutputStream. * Read the content of an InputStream multiple times or seek to a definite position

The newest version!

package com.gc.iotools.stream.writer;

/*
 * Copyright (c) 2008, 2015 Gabriele Contini. This source code is released
 * under the BSD License.
 */
import java.io.FilterWriter;
import java.io.IOException;
import java.io.Writer;

/**
 * 
 * A CloseShieldWriter wraps some other Writer, which
 * it uses as its basic sink of data. The class CloseShieldWriter
 * delegates all requests to the contained writer, except the
 * {@linkplain #close()} method that is not to the underlying stream.
 * 
 * 
 * This class is typically used in cases where a Writer needs to be
 * passed to a component that wants to explicitly close the stream but other
 * components still need to write data on it.
 * 
 * 
 * @author dvd.smnt
 * @since 1.2.8
 * @param 
 *            Type of the Writer passed in the constructor.
 * @version $Id: CloseShieldWriter.java 527 2014-02-24 19:29:50Z
 *           $
 */
public class CloseShieldWriter extends FilterWriter {
	private int closeCount = 0;

	/**
	 * Construct a CloseShieldWriter that forwards the calls to the
	 * source Writer passed in the constructor.
	 * 
	 * @param source
	 *            original Writer
	 * @param 
	 *            a T object.
	 */
	public CloseShieldWriter(final T source) {
		super(source);
		if (source == null) {
			throw new IllegalArgumentException("Source Writer can't be null");
		}
	}

	/**
	 * {@inheritDoc}
	 * 
	 * 
	 * Multiple invocation of this method will result in only one invocation of
	 * the close() on the underlying stream.
	 * 
	 */
	@Override
	public void close() throws IOException {
		this.closeCount++;
	}

	/**
	 * Returns the number of time that close was called.
	 * 
	 * @return Number of times that close was called
	 */
	public int getCloseCount() {
		return this.closeCount;
	}

	/**
	 * 
	 * Returns the wrapped (original) Writer passed in the
	 * constructor.
	 * 
	 * 
	 * @return The original Writer passed in the constructor
	 */
	public T getWrappedWriter() {
		@SuppressWarnings("unchecked")
		final T result = (T) this.out;
		return result;
	}

}