Package org.apache.tika.parser.code

Class SourceCodeParser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.parser.AbstractEncodingDetectorParser

org.apache.tika.parser.code.SourceCodeParser

All Implemented Interfaces:

Serializable, Parser

public class SourceCodeParser
extends AbstractEncodingDetectorParser

Generic Source code parser for Java, Groovy, C++. Aware: This parser uses JHightlight library (https://github.com/codelibs/jhighlight) under CDDL/LGPL dual license

Since:

1.6

Author:

Hong-Thai.Nguyen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SourceCodeParser()
SourceCodeParser(EncodingDetector encodingDetector)

Method Summary

Modifier and Type	Method	Description
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.

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

getEncodingDetector, getEncodingDetector, setEncodingDetector

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 Detail

SourceCodeParser

public SourceCodeParser()

SourceCodeParser

public SourceCodeParser(EncodingDetector encodingDetector)

Method Detail

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