Package org.apache.tika.parser.strings

Class StringsParser

java.lang.Object

org.apache.tika.parser.strings.StringsParser

All Implemented Interfaces:

Serializable, Initializable, SelfConfiguring, Parser

public class StringsParser
extends Object
implements Parser, Initializable

Parser that uses the "strings" (or strings-alternative) command to find the printable strings in a object, or other binary, file (application/octet-tis). Useful as "best-effort" parser for files detected as application/octet-tis.

Author:

gtotaro

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StringsParser()
StringsParser(JsonConfig jsonConfig)
StringsParser(StringsConfig config)

Method Summary

Modifier and Type	Method	Description
StringsConfig	getDefaultConfig()
static String	getStringsProg()
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	initialize()	Called after all properties have been set to allow for validation and initialization that depends on multiple properties.
void	parse(TikaInputStream tis, 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

Constructor Details

StringsParser

public StringsParser()

StringsParser

public StringsParser(StringsConfig config)

StringsParser

public StringsParser(JsonConfig jsonConfig)

Method Details

getStringsProg

public static String getStringsProg()

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.

Specified by:

getSupportedTypes in interface Parser

Parameters:

context - parse context

Returns:

immutable set of media types

parse

public void parse(TikaInputStream tis,
 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.

Specified by:

parse in interface Parser

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

getDefaultConfig

public StringsConfig getDefaultConfig()

initialize

public void initialize()
                throws TikaConfigException

Description copied from interface: Initializable

Called after all properties have been set to allow for validation and initialization that depends on multiple properties.

Specified by:

initialize in interface Initializable

Throws:

TikaConfigException - if there is a problem with the configuration