Package org.apache.daffodil.api

Interface InputSourceDataInputStream

All Superinterfaces:
AutoCloseable, Closeable
public interface InputSourceDataInputStream extends Closeable
Provides Daffodil with byte data from an InputStream, ByteBuffer, or byte Array.

Note that the InputStream variant has potential overhead due to streaming capabilities and support for files greater than 2GB. In some cases, better performance might come from using the byte array or ByteBuffer variants instead. For example, if your data is already in a byte array, one should use the Array[Byte] or ByteBuffer variants instead of wrapping it in a ByteArrayInputStream. As another example, instead of using a FileInputStream like this:

Path path = Paths.get(file); FileInputStream fis = Files.newInputStream(path); InputSourceDataInputStream input = InputSourceDataInputStream(fis);

You might consider mapping the file to a MappedByteBuffer like below, keeping in mind that MappedByteBuffers have size limitations and potentially different performance characteristics depending on the file size and system--it maybe not always be faster than above.

Path path = Paths.get(file); long size = Files.size(path); FileChannel fc = FileChannel.open(path, StandardOpenOption.READ); ByteBuffer bb = fc.map(FileChannel.MapMode.READ_ONLY, 0, size); fc.close(); InputSourceDataInputStream input = new InputSourceDataInputStream(bb);

  • Method Summary

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

  • Method Details

    • hasData

      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:
      true if the input stream has at least 1 bit of data.

    • close

      void close() throws IOException
      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.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException - if an I/O error occurs during the close operation.