org.apache.tika.parser.strings

Class StringsConfig

java.lang.Object

org.apache.tika.parser.strings.StringsConfig

All Implemented Interfaces:

Serializable

public class StringsConfig
extends Object
implements Serializable

Configuration for the "strings" (or strings-alternative) command.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringsConfig() Default contructor.
StringsConfig(InputStream is) Loads properties from InputStream and then tries to close InputStream.

Method Summary

Modifier and Type	Method and Description
StringsEncoding	getEncoding() Returns the character encoding of the strings that are to be found.
int	getMinLength() Returns the minimum sequence length (characters) to print.
String	getStringsPath() Returns the "strings" installation folder.
int	getTimeout() Returns the maximum time (in seconds) to wait for the "strings" command to terminate.
void	setEncoding(StringsEncoding encoding) Sets the character encoding of the strings that are to be found.
void	setMinLength(int minLength) Sets the minimum sequence length (characters) to print.
void	setStringsPath(String path) Sets the "strings" installation folder.
void	setTimeout(int timeout) Sets the maximum time (in seconds) to wait for the "strings" command to terminate.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringsConfig

public StringsConfig()

Default contructor.

StringsConfig

public StringsConfig(InputStream is)

Loads properties from InputStream and then tries to close InputStream. If there is an IOException, this silently swallows the exception and goes back to the default.

Parameters:

is -

Method Detail

getStringsPath

public String getStringsPath()

Returns the "strings" installation folder.

Returns:

the "strings" installation folder.

getMinLength

public int getMinLength()

Returns the minimum sequence length (characters) to print.

Returns:

the minimum sequence length (characters) to print.

getEncoding

public StringsEncoding getEncoding()

Returns the character encoding of the strings that are to be found.

Returns:

StringsEncoding enum that represents the character encoding of the strings that are to be found.

getTimeout

public int getTimeout()

Returns the maximum time (in seconds) to wait for the "strings" command to terminate.

Returns:

the maximum time (in seconds) to wait for the "strings" command to terminate.

setStringsPath

public void setStringsPath(String path)

Sets the "strings" installation folder.

Parameters:

path - the "strings" installation folder.

setMinLength

public void setMinLength(int minLength)

Sets the minimum sequence length (characters) to print.

Parameters:

minLength - the minimum sequence length (characters) to print.

setEncoding

public void setEncoding(StringsEncoding encoding)

Sets the character encoding of the strings that are to be found.

Parameters:

encoding - StringsEncoding enum that represents the character encoding of the strings that are to be found.

setTimeout

public void setTimeout(int timeout)

Sets the maximum time (in seconds) to wait for the "strings" command to terminate.

Parameters:

timeout - the maximum time (in seconds) to wait for the "strings" command to terminate.