org.apache.daffodil.japi.io

Class InputSourceDataInputStream

java.lang.Object

org.apache.daffodil.japi.io.InputSourceDataInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class InputSourceDataInputStream
extends java.lang.Object
implements java.io.Closeable

Provides Daffodil with byte data from an InputStream, ByteBuffer, or byte Array.

param: dis the underlying Scala InputSourceDataInputStream

Constructor Summary

Constructors

Constructor and Description
InputSourceDataInputStream(byte[] arr) Create an InputSourceDataInputStream from a byte array
InputSourceDataInputStream(java.nio.ByteBuffer bb) Create an InputSourceDataInputStream from a java.nio.ByteBuffer
InputSourceDataInputStream(org.apache.daffodil.io.InputSourceDataInputStream dis)
InputSourceDataInputStream(java.io.InputStream is) Create an InputSourceDataInputStream from a java.io.InputStream

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying resource.
org.apache.daffodil.io.InputSourceDataInputStream	dis()
boolean	hasData() Returns true if the input stream has at least 1 bit of data.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputSourceDataInputStream

public InputSourceDataInputStream(org.apache.daffodil.io.InputSourceDataInputStream dis)

InputSourceDataInputStream

public InputSourceDataInputStream(java.io.InputStream is)

Create an InputSourceDataInputStream from a java.io.InputStream

Parameters:

is - (undocumented)

InputSourceDataInputStream

public InputSourceDataInputStream(java.nio.ByteBuffer bb)

Create an InputSourceDataInputStream from a java.nio.ByteBuffer

Parameters:

bb - (undocumented)

InputSourceDataInputStream

public InputSourceDataInputStream(byte[] arr)

Create an InputSourceDataInputStream from a byte array

Parameters:

arr - (undocumented)

Method Detail

close

public void close()

Closes the underlying resource.

This method is used to close the underlying resource associated with the current instance. It is typically used to release any system resources that have been acquired during the lifespan of the instance.

throws IOException if an I/O error occurs during the close operation.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

dis

public org.apache.daffodil.io.InputSourceDataInputStream dis()

hasData

public boolean hasData()

Returns true if the input stream has at least 1 bit of data.

Does not advance the position.

Returns true immediately if the input stream has available data that has not yet been consumed.

On a network input stream, this may block to determine if the stream contains data or is at end-of-data.

This is used when parsing multiple elements from a stream to see if there is data or not before calling parse().

It may also be used after a parse() operation that is intended to consume the entire data stream (such as for a file) to determine if all data has been consumed or some data is left-over.

Returns:

(undocumented)