Package org.apache.tika.sax

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, links, images, lists (ordered and unordered, including nested), tables (GFM pipe tables), code blocks, inline code, blockquotes, horizontal rules, and definition lists.

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()

Methods inherited from class org.xml.sax.helpers.DefaultHandler

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

Methods inherited from class java.lang.Object

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

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

toString

public String toString()

Overrides:

toString in class Object