Class ToMarkdownContentHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.tika.sax.ToMarkdownContentHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class ToMarkdownContentHandler
extends DefaultHandler

SAX event handler that writes content as Markdown. Supports headings, paragraphs, bold, italic, strikethrough, links, images, lists (ordered and unordered, including nested), tables (GFM pipe tables), code blocks, inline code, blockquotes, horizontal rules, and definition lists.

The handler builds a commonmark-java document model from the SAX event stream and renders it with commonmark's MarkdownRenderer. Document text is added to the model as raw literals, so escaping of Markdown metacharacters — including characters that would otherwise break out of a link, image, or table cell — is performed in one place by the renderer rather than at each emit site.

The handler tolerates malformed input (unbalanced or misnested tags): block elements are always attached at a structurally valid point so a well-formed document model is rendered regardless of the event stream.

Content within <script> and <style> tags is ignored.

Since:

Apache Tika 3.2

Constructor Summary

Constructors

Constructor	Description
ToMarkdownContentHandler()
ToMarkdownContentHandler(OutputStream stream, String encoding)
ToMarkdownContentHandler(Writer writer)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(String uri, String localName, String qName)
void	ignorableWhitespace(char[] ch, int start, int length)
void	startElement(String uri, String localName, String qName, Attributes atts)
String	toString()
void	writePartialContentIfUnfinished()	Renders the document model accumulated so far to the underlying writer and flushes it, if it has not already been written.

Methods inherited from class DefaultHandler

endPrefixMapping, error, fatalError, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Constructor Details

ToMarkdownContentHandler

public ToMarkdownContentHandler(Writer writer)

ToMarkdownContentHandler

public ToMarkdownContentHandler(OutputStream stream,
 String encoding)
                         throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

ToMarkdownContentHandler

public ToMarkdownContentHandler()

Method Details

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int length)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

writePartialContentIfUnfinished

public void writePartialContentIfUnfinished()
                                     throws IOException

Renders the document model accumulated so far to the underlying writer and flushes it, if it has not already been written.

This handler buffers the whole document and only writes it to the writer in endDocument(), which a parser does not call when it aborts mid-document (a parse exception, or a write-limit abort with throwOnWriteLimitReached=true). Unlike the streaming text/HTML/XML handlers, that would leave an OutputStream/Writer consumer with an empty result. A parse driver that owns the writer can call this in a finally so partial Markdown is still emitted on failure. Idempotent: a no-op once the content has been written (including after a successful endDocument()).

Throws:

IOException - if writing to or flushing the underlying writer fails

toString

public String toString()

Overrides:

toString in class Object