org.apache.tika.parser.mbox
Class MboxParser

java.lang.Object
  org.apache.tika.parser.mbox.MboxParser

All Implemented Interfaces:

java.io.Serializable, Parser

public class MboxParser
extends java.lang.Object
implements Parser

Mbox (mailbox) parser. This version returns the headers for the first email via metadata, which means headers from subsequent emails will be lost.

See Also:

Serialized Form

Field Summary

static java.lang.String	MBOX_MIME_TYPE
static java.lang.String	MBOX_RECORD_DIVIDER

Constructor Summary

MboxParser()

Method Summary

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) The parse() method from Tika 0.4 and earlier.
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 java.lang.Object

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

Field Detail

MBOX_MIME_TYPE

public static final java.lang.String MBOX_MIME_TYPE

See Also:

Constant Field Values

MBOX_RECORD_DIVIDER

public static final java.lang.String MBOX_RECORD_DIVIDER

See Also:

Constant Field Values

Constructor Detail

MboxParser

public MboxParser()

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.

Specified by:

getSupportedTypes in interface Parser

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,
                  TikaException,
                  org.xml.sax.SAXException

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.

Specified by:

parse in interface Parser

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

TikaException - if the document could not be parsed

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

parse

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

Description copied from interface: Parser

The parse() method from Tika 0.4 and earlier. Please use the Parser.parse(InputStream, ContentHandler, Metadata, ParseContext) method instead in new code. Calls to this backwards compatibility method are forwarded to the new parse() method with an empty parse context.

Specified by:

parse in interface Parser

Throws:

java.io.IOException

org.xml.sax.SAXException

TikaException