Package org.apache.tika.parser.microsoft.rtf

Class RTFParser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.parser.microsoft.rtf.RTFParser

All Implemented Interfaces:

Serializable, Parser

public class RTFParser
extends AbstractParser

RTF parser

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RTFParser()

Method Summary

Modifier and Type	Method	Description
static int	getMaxBytesForEmbeddedObject()	Deprecated.
int	getMemoryLimitInKb()
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	parse(InputStream stream, ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.
static void	setMaxBytesForEmbeddedObject(int max)	Deprecated. use setMemoryLimitInKb(int) instead
void	setMemoryLimitInKb(int memoryLimitInKb)

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

parse

Methods inherited from class java.lang.Object

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

Constructor Details

RTFParser

public RTFParser()

Method Details

getMaxBytesForEmbeddedObject

@Deprecated
public static int getMaxBytesForEmbeddedObject()

Deprecated.

See setMaxBytesForEmbeddedObject(int).

Returns:

maximum number of bytes allowed for an embedded object.

setMaxBytesForEmbeddedObject

@Deprecated
public static void setMaxBytesForEmbeddedObject(int max)

Deprecated.

use setMemoryLimitInKb(int) instead

Bytes for embedded objects are currently cached in memory. If something goes wrong during the parsing of an embedded object, it is possible that a read length may be crazily too long and cause a heap crash.

Parameters:

max - maximum number of bytes to allow for embedded objects. If the embedded object has more than this number of bytes, skip it.

getSupportedTypes

public 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(InputStream stream,
 ContentHandler handler,
 Metadata metadata,
 ParseContext context)
           throws IOException,
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:

IOException - if the document stream could not be read

SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed

getMemoryLimitInKb

public int getMemoryLimitInKb()

setMemoryLimitInKb

@Field
public void setMemoryLimitInKb(int memoryLimitInKb)