net.sourceforge.javadpkg.io.impl

Class DataStreamTarget

java.lang.Object

net.sourceforge.javadpkg.io.impl.DataStreamTarget

All Implemented Interfaces:

Closeable, AutoCloseable, DataTarget

public class DataStreamTarget
extends Object
implements DataTarget

A DataTarget implementation based on a stream.

Version:

1.0, 31.12.2015 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
DataStreamTarget(OutputStream out, String name, boolean closeable) Creates a target.

Method Summary

Modifier and Type	Method and Description
void	close()
String	getName() Returns the name of the source.
OutputStream	getOutputStream() Returns a stream for writing the data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataStreamTarget

public DataStreamTarget(OutputStream out,
                        String name,
                        boolean closeable)

Creates a target.

Parameters:

out - The stream.

name - The name of the source.

closeable - The flag if the close() method will close the stream.

Throws:

IllegalArgumentException - If any of the parameters are null.

Method Detail

getName

public String getName()

Description copied from interface: DataTarget

Returns the name of the source.

This name is used e.g. for detail messages of exceptions.

Specified by:

getName in interface DataTarget

Returns:

The name.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Description copied from interface: DataTarget

Returns a stream for writing the data.

The method will always return the same OutputStream if the source is still open. If the OutputStream.close() method is called the source will behave the same as the Closeable.close() method was called.

Specified by:

getOutputStream in interface DataTarget

Returns:

The stream.

Throws:

IOException - If an I/O error occurs.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException