com.github.powerlibraries.io.helper.stringout.SBDataOutputStream 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.helper.stringout;

import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.OutputStream;

/**
 * This class extends a {@link DataOutputStream} with the ability to directly access an underlying 
 * {@link ByteArrayOutputStream} and to return a resulting string.
 * 
 * @see DataOutputStream
 * @see SBWrapper
 * @author Manuel Hegner
 */
public class SBDataOutputStream extends DataOutputStream implements SBWrapper {
	
	private StringBuilderOutputStream underlyingOutput;

	public SBDataOutputStream(OutputStream outputStream, StringBuilderOutputStream underlyingOutput) {
		super(outputStream);
		this.underlyingOutput=underlyingOutput;
	}
	
	/**
     * Converts the buffer's contents into a string decoding bytes using the
     * platform's default character set. The length of the new String
     * is a function of the character set, and hence may not be equal to the
     * size of the buffer.
     *
     *  This method always replaces malformed-input and unmappable-character
     * sequences with the default replacement string for the platform's
     * default character set. The {@linkplain java.nio.charset.CharsetDecoder}
     * class should be used when more control over the decoding process is
     * required.
     *
     * @return String decoded from the buffer's contents.
     */
	@Override
	public String toString() {
		return getUnderlyingOutput().toString();
	}

	@Override
	public StringBuilderOutputStream getUnderlyingOutput() {
		return underlyingOutput;
	}
}