Package org.apache.flink.api.java.io

Class 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.
    All Flink DataSet APIs are deprecated since Flink 1.18 and will be removed in a future Flink major version. You can still build your application in DataSet, but you should move to either the DataStream and/or Table API.
    Input Format that reads text files. Each line results in another element.
    See Also:
    FLIP-131: Consolidate the user-facing Dataflow SDKs/APIs (and deprecate the DataSet API, Serialized Form

    • 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, ENUMERATE_NESTED_FILES_FLAG, enumerateNestedFiles, filePath, 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

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      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.
       
      boolean supportsMultiPaths()
      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, loadGlobalConfigParams, 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, getFilePath, getFilePaths, getFileStats, getFileStats, getInflaterInputStreamFactory, getInputSplitAssigner, getMinSplitSize, getNestedFileEnumeration, getNumSplits, getOpenTimeout, getSplitLength, getSplitStart, 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

    • Constructor Detail

      • TextInputFormat

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

    • Method Detail

      • 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>

      • supportsMultiPaths

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