net.sourceforge.javadpkg.io.impl

Class DataStreamProducer

java.lang.Object

net.sourceforge.javadpkg.io.impl.DataStreamProducer

All Implemented Interfaces:

DataProducer

public class DataStreamProducer
extends Object
implements DataProducer

A DataProducer which reads the data from an InputStream.

Version:

1.0, 27.04.2016 by Gerrit Hohl

Author:

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

Constructor Summary

Constructors

Constructor and Description
DataStreamProducer(InputStream in, String name) Creates a producer.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of the producer in the exception (if one is thrown).
int	produce(byte[] buffer) Produces the data.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataStreamProducer

public DataStreamProducer(InputStream in,
                          String name)

Creates a producer.

Parameters:

in - The input stream.

name - The name of the producer in the exception (if one is thrown).

Throws:

IllegalArgumentException - If any of the parameters are null.

Method Detail

getName

public String getName()

Description copied from interface: DataProducer

Returns the name of the producer in the exception (if one is thrown).

Specified by:

getName in interface DataProducer

Returns:

The name.

produce

public int produce(byte[] buffer)
            throws IOException

Description copied from interface: DataProducer

Produces the data.

Specified by:

produce in interface DataProducer

Parameters:

buffer - The buffer which is filled with the data.

Returns:

The length of how much was filled into the passed buffer or -1, if the end of the produced data is reached.

Throws:

IOException - If an I/O error occurs.