Package org.apache.tika.parser.txt

Class TXTParser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.parser.AbstractEncodingDetectorParser

org.apache.tika.parser.txt.TXTParser

All Implemented Interfaces:

java.io.Serializable, Parser

public class TXTParser
extends AbstractEncodingDetectorParser

Plain text parser. The text encoding of the document stream is automatically detected based on the byte patterns found at the beginning of the stream and the given document metadata, most notably the charset parameter of a HttpHeaders.CONTENT_TYPE value.

This parser sets the following output metadata entries:

HttpHeaders.CONTENT_TYPE

text/plain; charset=...

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TXTParser()
TXTParser(EncodingDetector encodingDetector)

Method Summary

Modifier and Type	Method	Description
java.util.Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class org.apache.tika.parser.AbstractEncodingDetectorParser

getEncodingDetector, setEncodingDetector

Methods inherited from class org.apache.tika.parser.AbstractParser

parse

Methods inherited from class java.lang.Object

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

Constructor Detail

TXTParser

public TXTParser()

TXTParser

public TXTParser(EncodingDetector encodingDetector)

Method Detail

getSupportedTypes

public java.util.Set<MediaType> getSupportedTypes(ParseContext context)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Parameters:

context - parse context

Returns:

immutable set of media types

parse

public void parse(java.io.InputStream stream,
                  org.xml.sax.ContentHandler handler,
                  Metadata metadata,
                  ParseContext context)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  TikaException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Parameters:

stream - the document stream (input)

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

context - parse context

Throws:

java.io.IOException - if the document stream could not be read

org.xml.sax.SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed