Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.textextractors.configs.StringsConfig Class Reference

Public Member Functions

Boolean getExtractUTF16 ()
 
Boolean getExtractUTF8 ()
 
List< SCRIPTgetLanguageScripts ()
 
void setExtractUTF16 (boolean enabled)
 
void setExtractUTF8 (boolean enabled)
 
void setLanguageScripts (List< SCRIPT > scripts)
 

Private Attributes

Boolean extractUTF16
 
Boolean extractUTF8
 
List< SCRIPTlanguageScripts
 

Detailed Description

Allows for configuration of the TextExtractor obtained from TextExtractorFactory.getStringsExtractor().

The Strings extractor will extract strings from the Content instance. This class allows for the configuration of the encoding and language scripts that will be used.

See also
org.sleuthkit.autopsy.textextractors.TextExtractorFactory
org.sleuthkit.autopsy.coreutils.StringExtract.StringExtractUnicodeTable.SCRIPT
org.openide.util.Lookup

Definition at line 37 of file StringsConfig.java.

Member Function Documentation

Boolean org.sleuthkit.autopsy.textextractors.configs.StringsConfig.getExtractUTF16 ( )

Return whether extraction with UTF-16 encoding should be done.

Returns
Flag indicating if UTF-16 has been turned on/off

Definition at line 75 of file StringsConfig.java.

References org.sleuthkit.autopsy.textextractors.configs.StringsConfig.extractUTF16.

Boolean org.sleuthkit.autopsy.textextractors.configs.StringsConfig.getExtractUTF8 ( )

Returns whether extraction with UTF-8 encoding should be done.

Returns
Flag indicating if UTF-8 has been turned on/off

Definition at line 66 of file StringsConfig.java.

References org.sleuthkit.autopsy.textextractors.configs.StringsConfig.extractUTF8.

List<SCRIPT> org.sleuthkit.autopsy.textextractors.configs.StringsConfig.getLanguageScripts ( )

Gets the desired set of scripts to be used during extraction.

Returns
Set of language scripts to be used

Definition at line 96 of file StringsConfig.java.

References org.sleuthkit.autopsy.textextractors.configs.StringsConfig.languageScripts.

void org.sleuthkit.autopsy.textextractors.configs.StringsConfig.setExtractUTF16 ( boolean  enabled)

Enables UTF-16 encoding to be used during extraction.

Parameters
enabledFlag indicating if UTF-16 should be turned on

Definition at line 57 of file StringsConfig.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

void org.sleuthkit.autopsy.textextractors.configs.StringsConfig.setExtractUTF8 ( boolean  enabled)

Enables UTF-8 encoding to be used during reading.

Parameters
enabledFlag indicating if UTF-8 should be turned on

Definition at line 48 of file StringsConfig.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

void org.sleuthkit.autopsy.textextractors.configs.StringsConfig.setLanguageScripts ( List< SCRIPT scripts)

Sets the type of language scripts that will be used during extraction. See org.sleuthkit.autopsy.coreutils.StringExtract.StringExtractUnicodeTable.SCRIPT for more information about available scripts.

Parameters
scriptsDesired set of scripts to be used during extraction

Definition at line 87 of file StringsConfig.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

Member Data Documentation

Boolean org.sleuthkit.autopsy.textextractors.configs.StringsConfig.extractUTF16
private
Boolean org.sleuthkit.autopsy.textextractors.configs.StringsConfig.extractUTF8
private
List<SCRIPT> org.sleuthkit.autopsy.textextractors.configs.StringsConfig.languageScripts
private

The documentation for this class was generated from the following file:

Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.