Class

za.co.absa.cobrix.spark.cobol.source.streaming

FileStreamer

Related Doc: package streaming

Permalink

class FileStreamer extends SimpleStream

This class provides methods for streaming bytes from an HDFS file.

It is stateful, which means that it stores the offset until which the file has been consumed.

Instances of this class are not reusable, i.e. once the file is fully read it can neither be reopened nor can other file be consumed.

Exceptions thrown

IllegalArgumentException in case the file is not found in the underlying file system.

Linear Supertypes
SimpleStream, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileStreamer
  2. SimpleStream
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileStreamer(filePath: String, fileSystem: FileSystem, startOffset: Long = 0L, maximumBytes: Long = 0L)

    Permalink

    filePath

    String contained the fully qualified path to the file.

    fileSystem

    Underlying FileSystem point of access.

    Exceptions thrown

    IllegalArgumentException in case the file is not found in the underlying file system.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def close(): Unit

    Permalink
    Definition Classes
    FileStreamer → SimpleStream
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. def inputFileName: String

    Permalink
    Definition Classes
    FileStreamer → SimpleStream
  13. def isEndOfStream: Boolean

    Permalink
    Definition Classes
    SimpleStream
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def next(numberOfBytes: Int): Array[Byte]

    Permalink

    Retrieves a given number of bytes.

    Retrieves a given number of bytes.

    One of three situations is possible:

    1. There's enough data to be read, thus, the resulting array's length will be exactly numberOfBytes. 2. There's not enough data but at least some, thus, the resulting array's length will be the number of available bytes. 3. The end of the file was already reached, in which case the resulting array will be empty.

    Definition Classes
    FileStreamer → SimpleStream
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def offset: Long

    Permalink
    Definition Classes
    FileStreamer → SimpleStream
  20. def size: Long

    Permalink
    Definition Classes
    FileStreamer → SimpleStream
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SimpleStream

Inherited from AnyRef

Inherited from Any

Ungrouped