Package org.apache.flink.streaming.api.legacy.io

Class TextInputFormat

java.lang.Object
org.apache.flink.api.common.io.RichInputFormat<OT,org.apache.flink.core.fs.FileInputSplit>
org.apache.flink.api.common.io.FileInputFormat<OT>
org.apache.flink.api.common.io.DelimitedInputFormat<String>
org.apache.flink.streaming.api.legacy.io.TextInputFormat
All Implemented Interfaces:
Serializable, org.apache.flink.api.common.io.CheckpointableInputFormat<org.apache.flink.core.fs.FileInputSplit,Long>, org.apache.flink.api.common.io.InputFormat<String,org.apache.flink.core.fs.FileInputSplit>, org.apache.flink.core.io.InputSplitSource<org.apache.flink.core.fs.FileInputSplit>
@Deprecated @PublicEvolving public class TextInputFormat extends org.apache.flink.api.common.io.DelimitedInputFormat<String>
Deprecated.
If you want to read/write data from/to text file, please use FLIP-27 FileSource and Sink-V2 FlinkSink. This class should be removed if we drop the supports for read/write via input/output format in DataStream api.
Input Format that reads text files. Each line results in another element.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.apache.flink.api.common.io.FileInputFormat

    org.apache.flink.api.common.io.FileInputFormat.FileBaseStatistics, org.apache.flink.api.common.io.FileInputFormat.InputSplitOpenThread

  • Field Summary

    Fields inherited from class org.apache.flink.api.common.io.DelimitedInputFormat

    currBuffer, currLen, currOffset, RECORD_DELIMITER

    Fields inherited from class org.apache.flink.api.common.io.FileInputFormat

    currentSplit, enumerateNestedFiles, INFLATER_INPUT_STREAM_FACTORIES, minSplitSize, numSplits, openTimeout, READ_WHOLE_SPLIT_FLAG, splitLength, splitStart, stream, unsplittable

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextInputFormat(org.apache.flink.core.fs.Path filePath)
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure(org.apache.flink.configuration.Configuration parameters)
    Deprecated.
     
    String
    getCharsetName()
    Deprecated.
     
    String
    readRecord(String reusable, byte[] bytes, int offset, int numBytes)
    Deprecated.
     
    void
    setCharsetName(String charsetName)
    Deprecated.
     
    String
    toString()
    Deprecated.
     

    Methods inherited from class org.apache.flink.api.common.io.DelimitedInputFormat

    close, getBufferSize, getCharset, getCurrentState, getDelimiter, getLineLengthLimit, getNumLineSamples, getStatistics, initializeSplit, loadConfigParameters, nextRecord, open, reachedEnd, readLine, reopen, setBufferSize, setCharset, setDelimiter, setDelimiter, setDelimiter, setLineLengthLimit, setNumLineSamples

    Methods inherited from class org.apache.flink.api.common.io.FileInputFormat

    acceptFile, createInputSplits, decorateInputStream, extractFileExtension, getFilePaths, getFileStats, getFileStats, getInflaterInputStreamFactory, getInputSplitAssigner, getMinSplitSize, getNestedFileEnumeration, getNumSplits, getOpenTimeout, getSplitLength, getSplitStart, getSupportedCompressionFormats, registerInflaterInputStreamFactory, setFilePath, setFilePath, setFilePaths, setFilePaths, setFilesFilter, setMinSplitSize, setNestedFileEnumeration, setNumSplits, setOpenTimeout, testForUnsplittable

    Methods inherited from class org.apache.flink.api.common.io.RichInputFormat

    closeInputFormat, getRuntimeContext, openInputFormat, setRuntimeContext

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TextInputFormat

      public TextInputFormat(org.apache.flink.core.fs.Path filePath)
      Deprecated.

  • Method Details

    • getCharsetName

      public String getCharsetName()
      Deprecated.

    • setCharsetName

      public void setCharsetName(String charsetName)
      Deprecated.

    • configure

      public void configure(org.apache.flink.configuration.Configuration parameters)
      Deprecated.
      Specified by:
      configure in interface org.apache.flink.api.common.io.InputFormat<String,org.apache.flink.core.fs.FileInputSplit>
      Overrides:
      configure in class org.apache.flink.api.common.io.DelimitedInputFormat<String>

    • readRecord

      public String readRecord(String reusable, byte[] bytes, int offset, int numBytes) throws IOException
      Deprecated.
      Specified by:
      readRecord in class org.apache.flink.api.common.io.DelimitedInputFormat<String>
      Throws:
      IOException

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class org.apache.flink.api.common.io.FileInputFormat<String>