Apache Tika

https://tika.apache.org/3.2.3/
Admin
Apache Tika is a toolkit that detects and extracts metadata and text from over a thousand different...
Tokens:1,581,828
Snippets:19,994
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### start() Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/fs/FSListCrawler.html

Starts the crawling process by adding FileResources to the queue. This method should be implemented to control the addition of FileResources.

```APIDOC
## start()

### Description
Implement this to control the addition of FileResources. Call `FileResourceCrawler.tryToAdd(org.apache.tika.batch.FileResource)` to add FileResources to the queue.

### Method
`void start() throws InterruptedException`

### Throws
- **InterruptedException**
```

--------------------------------

### Start XMP Document

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/sax/XMPContentHandler.html

Starts an XMP document by setting up namespace mappings and writing the RDF header. This method overrides the startDocument method from the parent class.

```java
public
void startDocument()
                   throws SAXException

Starts an XMP document by setting up the namespace mappings and writing out the following header: 
 <rdf:RDF> 


Specified by:
    startDocument in interface ContentHandler 

Overrides:
    startDocument in class ContentHandlerDecorator 

Throws:
    SAXException
```

--------------------------------

### Start XHTML Document

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/sax/XHTMLContentHandler.html

Starts an XHTML document by setting up namespace mappings. The XHTML prefix is generated lazily on the first element start.

```java
public void startDocument() 
                   throws SAXException
```

--------------------------------

### Example Parsers Supported Types

Source: https://tika.apache.org/3.2.3/api/index-all.html

Methods to get supported types for example parsers.

```APIDOC
## DirListParser.getSupportedTypes(ParseContext)

### Description
Gets the supported types.

### Method
Method

### Parameters
- **param1** (ParseContext) - Description
```

```APIDOC
## EncryptedPrescriptionParser.getSupportedTypes(ParseContext)

### Description
Gets the supported types.

### Method
Method

### Parameters
- **param1** (ParseContext) - Description
```

```APIDOC
## PrescriptionParser.getSupportedTypes(ParseContext)

### Description
Gets the supported types.

### Method
Method

### Parameters
- **param1** (ParseContext) - Description
```

--------------------------------

### start()

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/FileResourceCrawler.html

Abstract method to be implemented by subclasses to control the addition of FileResources to the queue. It should utilize the tryToAdd() method.

```APIDOC
## start()

### Description
Implement this to control the addition of FileResources. Call `tryToAdd(org.apache.tika.batch.FileResource)` to add FileResources to the queue.

### Throws
* `InterruptedException`
```

--------------------------------

### main() Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/fs/strawman/StrawManTikaAppDriver.html

The entry point for the StrawManTikaAppDriver application.

```APIDOC
## main(String[] args)

### Description
This is the static main method that serves as the entry point for the application. It likely handles command-line arguments and initiates the StrawManTikaAppDriver process.

### Method
public static void main(String[] args)
```

--------------------------------

### Get Started Timestamp

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/async/AsyncStatus.html

Retrieves the timestamp indicating when the asynchronous operation was started. Useful for tracking duration.

```java
public Instant getStarted()
```

--------------------------------

### Get Index Copy To Start

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GlobalIdTableEntry3FNDX.html

Retrieves the starting index for the copy destination. This method is part of the GlobalIdTableEntry3FNDX class.

```java
public long getIndexCopyToStart()

```

--------------------------------

### Get Index Copy From Start

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GlobalIdTableEntry3FNDX.html

Retrieves the starting index for copying entries. This method is part of the GlobalIdTableEntry3FNDX class.

```java
public long getIndexCopyFromStart()

```

--------------------------------

### Initialization with Params

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/config/class-use/Param.html

Demonstrates how components initialize themselves using a map of Params.

```APIDOC
## Initialization with Params

### Description
Components can be initialized with a map of parameters, where keys are strings and values are `Param` objects.

### Methods

#### `void initialize(Map<String, Param> params)`
Initializes an object using a provided map of parameters. This method is found in interfaces like `Initializable` and various parser/filter implementations.
```

--------------------------------

### Get Milliseconds Since Last Parse Started

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/server/core/ServerStatus.html

Returns the time in milliseconds since the last parsing operation started.

```java
public long getMillisSinceLastParseStarted()
```

--------------------------------

### FuzzOne Main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/fuzzing/cli/FuzzOne.html

The entry point for the FuzzOne command-line tool. It takes command-line arguments and initiates the fuzzing process.

```APIDOC
## main(String[] args)

### Description
This is the main method that serves as the entry point for the FuzzOne command-line application. It is responsible for processing command-line arguments and initiating the fuzzing process.

### Method
`public static void main(String[] args) throws Exception`

### Parameters
* **args** (String[]) - An array of strings representing the command-line arguments passed to the application.

### Throws
* **Exception** - This method may throw an `Exception` if an error occurs during the fuzzing process.
```

--------------------------------

### main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/MediaTypeExample.html

The entry point for the MediaTypeExample application. It can throw exceptions.

```java
public static
void
main(String[] args)
                 throws Exception
```

--------------------------------

### ExGUIDArray.getContent

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/fsshttpb/streamobj/basic/class-use/ExGuid.html

Gets or sets an extended GUID array.

```APIDOC
## ExGUIDArray.getContent

### Description
Gets or sets an extended GUID array.

### Method Signature
`List<ExGuid>` ExGUIDArray.`getContent()`

### Returns
A list of ExGuid objects.
```

--------------------------------

### start() Method Implementation

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/fs/FSDirectoryCrawler.html

Implement this method to control the addition of FileResources to the queue. Use FileResourceCrawler.tryToAdd() to add resources. This method can throw InterruptedException.

```java
public void start()
           throws InterruptedException
```

--------------------------------

### getStartupTimeoutMillis

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/PipesConfigBase.html

Gets the timeout in milliseconds for starting up processes.

```APIDOC
## getStartupTimeoutMillis

### Description
Gets the timeout in milliseconds for starting up processes.

### Method
```java
public long getStartupTimeoutMillis()
```
```

--------------------------------

### Get Strings Path

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/strings/StringsParser.html

Retrieves the configured path to the 'strings' installation folder.

```java
public String
getStringsPath()
```

--------------------------------

### main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/MyFirstTika.html

The entry point of the MyFirstTika application.

```APIDOC
## main(String[] args)

### Description
This is the main method that serves as the entry point for the application. It can be used to run the example functionalities.

### Method Signature
`public static void main(String[] args) throws Exception`

### Throws
`Exception`
```

--------------------------------

### OBJ

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/fuzzing/pdf/EvilCOSWriter.html

The starting object token.

```APIDOC
## OBJ

### Description
The starting object token.

### Type
`byte[]`
```

--------------------------------

### main

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/DisplayMetInstance.html

The main entry point for the DisplayMetInstance application. It processes command-line arguments to fetch and display metadata from a URL.

```APIDOC
## main

### Description
The main entry point for the DisplayMetInstance application. It processes command-line arguments to fetch and display metadata from a URL.

### Method
`public static void main(String[] args)`

### Parameters
#### Path Parameters
- **args** (String[]) - Command-line arguments, expected to contain a URL.

### Throws
- `Exception`
```

--------------------------------

### Get Media Subtype

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/mime/MediaType.html

Returns the subtype component of the MediaType. For example, 'plain' from 'text/plain'.

```java
public String getSubtype()
```

--------------------------------

### Get Media Type

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/mime/MediaType.html

Returns the main type component of the MediaType. For example, 'text' from 'text/plain'.

```java
public String getType()
```

--------------------------------

### initialize

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/renderer/pdf/pdfbox/PDFBoxRenderer.html

Initializes the renderer with the provided parameters.

```APIDOC
## initialize

### Description
Initializes the renderer with the provided parameters.

### Method Signature
`public void initialize(Map<String, Param> params) throws TikaConfigException`

### Parameters
* **params** (Map<String, Param>) - Parameters to use for initialization.

### Throws
* `TikaConfigException`
```

--------------------------------

### getPropertyTag

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/msg/TikaNameIdChunks.html

Gets the property tag ID by property set GUID and name or ID from named properties mapping.

```APIDOC
## getPropertyTag(ClassID guid, String name, long id)

### Description
Get property tag id by property set GUID and string name or numerical name from named properties mapping.

### Method
`public long getPropertyTag(org.apache.poi.hpsf.ClassID guid, String name, long id)`

### Parameters
* **guid** (org.apache.poi.hpsf.ClassID) - Property set GUID in registry format without brackets. May be one of the PS_* or PSETID_* constants.
* **name** (String) - Property name in case of string named property.
* **id** (long) - Property id in case of numerical named property.

### Returns
Property tag which can be matched with `MAPIProperty.id` or 0 if the property could not be found.
```

--------------------------------

### Get Base Media Type

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/mime/MediaType.html

Retrieves the base media type without any parameters. For example, 'text/plain' from 'text/plain; charset=utf-8'.

```java
public MediaType getBaseType()
```

--------------------------------

### Main Method for Standards Extraction

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/StandardsExtractionExample.html

Entry point for the example. Executes the extraction process for files in a given directory. Run using Maven with the command: mvn exec:java -Dexec.mainClass="org.apache.tika.example.StandardsExtractionExample" -Dexec.args="/path/to/input" from the tika-example directory.

```java
public static void main(String[] args)
```

--------------------------------

### main(String[] args)

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/CustomMimeInfo.html

The main entry point for the CustomMimeInfo class.

```APIDOC
## main(String[] args)

### Description
The main entry point for the CustomMimeInfo class. This method can be used to run the utility.

### Method
`public static void main(String[] args) throws Exception`

### Parameters
* **args** (String[]) - Command line arguments.

### Throws
`Exception`
```

--------------------------------

### MarianTranslator Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/language/translate/impl/MarianTranslator.html

Default constructor for MarianTranslator. No specific setup is required beyond ensuring Marian NMT is installed and configured.

```java
public MarianTranslator()
```

--------------------------------

### initialize

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/emitter/opensearch/OpenSearchEmitter.html

Initializes the emitter with the provided parameters.

```APIDOC
## initialize

### Description
Initializes the emitter with the provided parameters.

### Method
public void initialize(Map<String, Param> params) throws TikaConfigException

### Parameters
* **params** (Map<String, Param>) - Parameters to use for initialization.

### Throws
* **TikaConfigException** - If initialization fails.
```

--------------------------------

### Create Default TikaConfig

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/config/TikaConfig.html

Provides a default Tika configuration. This is useful for getting a standard setup without custom loading.

```java
public static TikaConfig getDefaultConfig()
  Provides a default configuration (TikaConfig).
```

--------------------------------

### Get Current File Being Processed

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/FileResourceConsumer.html

Retrieves the name and start time of the file currently being processed. Returns null if no file is being processed.

```java
public org.apache.tika.batch.FileStarted getCurrentFile()
```

--------------------------------

### initialize

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/reporters/opensearch/OpenSearchPipesReporter.html

Initializes the OpenSearch Pipes Reporter with the provided parameters.

```APIDOC
## initialize

### Description
Initializes the OpenSearch Pipes Reporter.

### Method
`initialize`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **params** (object) - Required - Parameters to use for initialization.

### Request Example
```json
{
  "params": {}
}
```

### Response
#### Success Response (200)
Void

#### Response Example
None
```

--------------------------------

### Loading AsyncConfig

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/async/class-use/AsyncConfig.html

Demonstrates how to load an AsyncConfig from a given path.

```APIDOC
## static AsyncConfig load(Path p)

### Description
Loads an AsyncConfig from the specified Path.

### Method
static

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
- **p** (Path) - Required - The path to the configuration file.

### Response
#### Success Response (AsyncConfig)
- Returns an AsyncConfig object loaded from the provided path.

### Response Example
```json
{
  "example": "AsyncConfig object"
}
```
```

--------------------------------

### Get Filtered Stack Trace

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/utils/ExceptionUtils.html

Retrieves a simplified stack trace by unwrapping TikaExceptions. Ensure JVM is started with -XX:-OmitStackTraceInFastThrow if stack traces are truncated.

```java
public static	String	getFilteredStackTrace	(Throwable	t)
```

--------------------------------

### main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/fs/FSBatchProcessCLI.html

The entry point for the FSBatchProcessCLI application. This method executes the batch process and can throw various exceptions.

```APIDOC
## main(String[] args)

### Description
Entry point for the FSBatchProcessCLI. This static method starts the batch processing operation.

### Throws
* `Exception`
```

--------------------------------

### TikaNameIdChunks.getPropertyTag() Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/msg/TikaNameIdChunks.html

Gets a property tag ID based on a property set GUID and either a string name or a numerical ID. This is used for mapping named properties.

```java
public long getPropertyTag(org.apache.poi.hpsf.ClassID guid,
                           String name,
                           long id)
```

--------------------------------

### StrawManTikaAppDriver main() Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/fs/strawman/StrawManTikaAppDriver.html

The entry point for the StrawManTikaAppDriver application. This static method accepts command-line arguments to initiate the batch processing.

```java
public static
void
main(String[]
args)
```

--------------------------------

### Get Short (Little Endian) from Byte Array with Offset

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/io/EndianUtils.html

Retrieves a 16-bit signed integer from a byte array starting at a specified offset in Little Endian format.

```java
public static short getShortLE(byte[] data,

```

--------------------------------

### ConfigBase Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/config/ConfigBase.html

Initializes a new instance of the ConfigBase class.

```APIDOC
## ConfigBase()

### Description
Initializes a new instance of the ConfigBase class.

### Constructor
`public ConfigBase()`
```

--------------------------------

### AmazonTranscribe Methods using ParseContext

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/class-use/ParseContext.html

Methods within AmazonTranscribe that utilize the ParseContext for operations like getting supported media types and parsing content, including starting an AWS Transcribe Job.

```APIDOC
## AmazonTranscribe.getSupportedTypes

### Description
Returns the set of media types supported by the AmazonTranscribe parser, using the provided ParseContext.

### Method
Set<MediaType>

### Parameters
- **context** (ParseContext) - The parsing context.

## AmazonTranscribe.parse

### Description
Parses the content of an InputStream into a ContentHandler, using Metadata and ParseContext. This method starts an AWS Transcribe Job with language specification.

### Method
void

### Parameters
- **stream** (InputStream) - The input stream to parse.
- **handler** (ContentHandler) - The content handler to process the parsed data.
- **metadata** (Metadata) - The metadata associated with the document.
- **context** (ParseContext) - The parsing context.
```

--------------------------------

### Detect Best Matching Charset

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/txt/CharsetDetector.html

Call this method to get the CharsetMatch object representing the best matching charset for the input data. Returns null if no matches are found. Note that detection is based on the start of the input data.

```java
public CharsetMatch detect()

```

--------------------------------

### Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/metadata/Metadata.html

Initializes a new, empty metadata object.

```APIDOC
## Constructor: Metadata()

Constructs a new, empty metadata.
```

--------------------------------

### startPrefixMapping Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/odf/NSNormalizerContentHandler.html

Handles the start of a prefix mapping, used for namespace declarations.

```APIDOC
## startPrefixMapping Method

### Description
Called when a prefix is mapped to a namespace URI. This method is overridden to handle namespace normalization for ODF documents.

### Method
`void startPrefixMapping(String prefix, String uri)`

### Parameters
* **prefix** (String) - The prefix being mapped.
* **uri** (String) - The namespace URI.

### Throws
* `SAXException`
```

--------------------------------

### GUID fromCurlyBraceUTF16Bytes Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Converts a GUID from a byte array formatted as {AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE} in UTF-16 encoding to a GUID object. This is useful for parsing GUIDs from byte streams.

```java
public static	GUID	fromCurlyBraceUTF16Bytes	(byte[]	guid)
```

--------------------------------

### GlobalIdTableEntryFNDX getGuid Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GlobalIdTableEntryFNDX.html

Retrieves the GUID associated with this GlobalIdTableEntryFNDX. The GUID is of type GUID.

```java
public GUID getGuid()

```

--------------------------------

### ServerStatus.start Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/server/core/class-use/ServerStatus.TASK.html

Details the ServerStatus.start method which accepts a ServerStatus.TASK enum.

```APIDOC
## `ServerStatus.start(ServerStatus.TASK task, String fileName, long timeoutMillis)`

### Description
Starts a task with the given parameters.

### Method
`long start(ServerStatus.TASK task, String fileName, long timeoutMillis)`

### Parameters
#### Path Parameters
- **task** (ServerStatus.TASK) - The type of task to start.
- **fileName** (String) - The name of the file associated with the task.
- **timeoutMillis** (long) - The timeout for the task in milliseconds.
```

--------------------------------

### GUID Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Initializes a new GUID object with the provided integer array representing the GUID.

```java
public	GUID	(int[]	guid)
```

--------------------------------

### initialize Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/dl/imagerec/DL4JInceptionV3Net.html

Initializes the recogniser with the provided parameters.

```APIDOC
## initialize(Map<String, Param> params)

### Description
This is the hook for configuring the recogniser.

### Method
`public void initialize(Map<String, Param> params) throws TikaConfigException`

### Parameters
* `params` (Map<String, Param>) - Configuration instance in the form of context.

### Throws
* `TikaConfigException` - when there is an issue with configuration.
```

--------------------------------

### GUID Static Methods

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/class-use/GUID.html

Static methods available on the GUID class for creating and converting GUID objects.

```APIDOC
## GUID.fromCurlyBraceUTF16Bytes(byte[] guid)

### Description
Converts a GUID of format: {AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE} (in bytes) to a GUID object.

### Method
`static GUID`

### Parameters
* **guid** (byte[]) - Description of the byte array representing the GUID.

### Returns
* `GUID` - The converted GUID object.
```

```APIDOC
## GUID.nil()

### Description
Returns a null or nil GUID object.

### Method
`static GUID`

### Returns
* `GUID` - A nil GUID object.
```

--------------------------------

### FuzzOne Main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/fuzzing/cli/FuzzOne.html

The main entry point for the FuzzOne command-line application. It accepts String arguments and can throw an Exception.

```java
public static void
main(String[] args)
                 throws Exception
```

--------------------------------

### GUID setGuid Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Sets the GUID using a new integer array. Returns the modified GUID object.

```java
public	GUID	setGuid	(int[]	guid)
```

--------------------------------

### Initializing PipesParser

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/class-use/PipesConfig.html

Shows how to initialize a PipesParser with a PipesConfig object.

```APIDOC
## Initialize PipesParser

### Description
Constructs a new PipesParser instance using a provided PipesConfig.

### Constructor
- `PipesParser(PipesConfig pipesConfig)`
```

--------------------------------

### Method Summary

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/fsshttpb/unsigned/UByte.html

Methods available for UByte instances and static utility methods.

```APIDOC
### Methods

**Instance Methods:**
- `UByte add(int val)`: Adds an integer value to this UByte.
- `UByte add(UByte val)`: Adds another UByte value to this UByte.
- `int compareTo(UByte o)`: Compares this UByte with another UByte.
- `double doubleValue()`: Returns the value of this UByte as a double.
- `boolean equals(Object obj)`: Checks if this UByte is equal to another object.
- `float floatValue()`: Returns the value of this UByte as a float.
- `int hashCode()`: Returns the hash code of this UByte.
- `int intValue()`: Returns the value of this UByte as an int.
- `long longValue()`: Returns the value of this UByte as a long.
- `UByte subtract(int val)`: Subtracts an integer value from this UByte.
- `UByte subtract(UByte val)`: Subtracts another UByte value from this UByte.
- `BigInteger toBigInteger()`: Gets this number as a `BigInteger`.
- `String toString()`: Returns a string representation of this UByte.

**Static Methods:**
- `static UByte valueOf(byte value)`: Gets an instance of an `unsigned byte` by masking it with `0xFF`.
- `static UByte valueOf(int value)`: Gets an instance of an `unsigned byte`.
- `static UByte valueOf(long value)`: Gets an instance of an `unsigned byte`.
- `static UByte valueOf(short value)`: Gets an instance of an `unsigned byte`.
- `static UByte valueOf(String value)`: Gets an instance of an `unsigned byte`.
```

--------------------------------

### GUID compareTo Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Compares this GUID object with another GUID object for order. Implements the Comparable interface.

```java
public int	compareTo	(GUID	o)
```

--------------------------------

### getGuid() - GUID

Source: https://tika.apache.org/3.2.3/api/index-all.html

Retrieves the GUID.

```APIDOC
## getGuid()

### Description
Retrieves the GUID.

### Method
N/A (Java method)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### initialize

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/RegexCaptureParser.html

Initializes the parser with the given parameters.

```APIDOC
## initialize(Map<String, Param> params)

### Description
Initializes the parser with the given parameters.

### Method
`public void initialize(Map<String, Param> params) throws TikaConfigException`

### Parameters
* `params` (Map<String, Param>) - params to use for initialization

### Throws
* `TikaConfigException`
```

--------------------------------

### startElement Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/sax/xpath/MatchingContentHandler.html

Handles the start of an element, potentially passing it to the delegate if it matches the XPath.

```APIDOC
## startElement Method

### Description
Handles the start of an element, potentially passing it to the delegate if it matches the XPath.

### Method
`void startElement(String uri, String localName, String name, Attributes attributes)`

### Throws
`SAXException`
```

--------------------------------

### GUID Constructor

Source: https://tika.apache.org/3.2.3/api/index-all.html

Constructor for the GUID class.

```APIDOC
## GUID GUID(int[])

### Description
Constructor for the GUID class.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### getGuidString() - GUID

Source: https://tika.apache.org/3.2.3/api/index-all.html

Retrieves the GUID as a string.

```APIDOC
## getGuidString()

### Description
Retrieves the GUID as a string.

### Method
N/A (Java method)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### initialize

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/reporters/fs/FileSystemStatusReporter.html

Initializes the reporter with the provided parameters.

```APIDOC
## initialize(Map<String, Param> params)

### Description
Initializes the reporter with the provided parameters.

### Method
`public void initialize(Map<String, Param> params) throws TikaConfigException`

### Parameters
#### Path Parameters
- **params** (Map<String, Param>) - Required - Parameters to use for initialization.

### Throws
- `TikaConfigException` - If initialization fails.
```

--------------------------------

### main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/gui/TikaGUI.html

The main entry point for the Tika GUI application. It initializes the Swing look and feel and starts the GUI.

```APIDOC
## main Method

### Description
Main method to launch the Tika GUI. Sets the Swing look and feel to the operating system settings and starts the Tika GUI with an `AutoDetectParser` instance as the default parser.

### Parameters
* **args** (String[]) - Ignored.

### Throws
* **Exception** - If an error occurs during initialization or execution.
```

--------------------------------

### Get EncodingDetector

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/AbstractEncodingDetectorParser.html

Gets the configured EncodingDetector.

```java
public EncodingDetector getEncodingDetector()
```

--------------------------------

### initialize

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/emitter/jdbc/JDBCEmitter.html

Initializes the emitter with a map of parameters.

```APIDOC
## initialize

### Description
Initializes the emitter with a map of parameters.

### Method
```java
public void initialize(Map<String, Param> params) throws TikaConfigException
```

### Parameters
#### Path Parameters
- **params** (Map<String, Param>) - Required - Parameters to use for initialization.

### Throws
- `TikaConfigException`
```

--------------------------------

### GUID Constructors

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Provides information on how to create new GUID objects.

```APIDOC
## GUID Constructor

### Description
Initializes a new instance of the `GUID` class.

### Constructor
```java
public GUID(int[] guid)
```

### Parameters
* **guid** (int[]) - An array of integers representing the GUID.
```

--------------------------------

### MSOneStorePackage Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/fsshttpb/MSOneStorePackage.html

Initializes a new instance of the MSOneStorePackage class.

```APIDOC
## MSOneStorePackage()

### Description
Initializes a new instance of the MSOneStorePackage class.

### Constructor
`public MSOneStorePackage()`
```

--------------------------------

### TikaClient Get Method

Source: https://tika.apache.org/3.2.3/api/index-all.html

Method to get data using TikaClient.

```APIDOC
## TikaClient.get(HttpClientFactory, List<String>)

### Description
Retrieves data using the provided HttpClientFactory and a list of strings.

### Method
Static

### Endpoint
N/A (Java Method)

### Parameters
- **httpClientFactory** (HttpClientFactory) - The factory for creating HTTP clients.
- **strings** (List<String>) - A list of strings to be used in the retrieval process.
```

--------------------------------

### StartXRefScanner Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/pdf/updates/StartXRefScanner.html

Initializes a new instance of the StartXRefScanner class.

```APIDOC
## StartXRefScanner Constructor

### Description
Initializes a new instance of the `StartXRefScanner` class.

### Signature
```java
public StartXRefScanner(org.apache.pdfbox.io.RandomAccessRead source)
```

### Parameters
* **source** (org.apache.pdfbox.io.RandomAccessRead) - The source to scan for startxref offsets.
```

--------------------------------

### initialize(Map<String, Param> params)

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/emitter/s3/S3Emitter.html

Initializes the S3 client with the provided parameters.

```APIDOC
## initialize

### Description
Initializes the `S3Emitter` and its underlying S3 client using a map of parameters.

### Method
`void initialize(Map<String, Param> params)`

### Parameters
- **params** (Map<String, Param>): A map of initialization parameters, typically including region, credentials, and bucket information.
```

--------------------------------

### GUID Instance Methods

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Details instance methods for interacting with GUID objects.

```APIDOC
## GUID Instance Methods

### compareTo

#### Description
Compares this GUID to another object for order.

#### Method
```java
public int compareTo(GUID o)
```

#### Parameters
* **o** (GUID) - The GUID to compare to.

#### Returns
A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

### equals

#### Description
Indicates whether some other object is "equal to" this one.

#### Method
```java
public boolean equals(Object o)
```

#### Parameters
* **o** (Object) - The reference object with which to compare.

#### Returns
`true` if this object is the same as the obj argument; `false` otherwise.

### hashCode

#### Description
Returns a hash code value for the GUID.

#### Method
```java
public int hashCode()
```

#### Returns
A hash code value for this object.

### toString

#### Description
Returns a string representation of the GUID.

#### Method
```java
public String toString()
```

#### Returns
A string representation of the GUID.

### getGuid

#### Description
Gets the integer array representation of the GUID.

#### Method
```java
public int[] getGuid()
```

#### Returns
An integer array representing the GUID.

### setGuid

#### Description
Sets the integer array representation of the GUID.

#### Method
```java
public GUID setGuid(int[] guid)
```

#### Parameters
* **guid** (int[]) - The integer array to set as the GUID.

#### Returns
The updated GUID object.

### getGuidString

#### Description
Gets the string representation of the GUID.

#### Method
```java
public String getGuidString()
```

#### Returns
A string representation of the GUID.

### toByteArray

#### Description
Converts the GUID to a list of bytes.

#### Method
```java
public List<Byte> toByteArray()
```

#### Returns
A list of bytes representing the GUID.
```

--------------------------------

### Method: startElement

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/sax/ToTextContentHandler.html

Handles the start of an element.

```APIDOC
## Method Detail
### startElement
```java
public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
                  throws SAXException
```
```

--------------------------------

### GUID getGuid Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Retrieves the internal integer array representation of the GUID.

```java
public int[]	getGuid()
```

--------------------------------

### GUID Instance Methods

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/class-use/GUID.html

Instance methods available on the GUID class for comparison and setting.

```APIDOC
## GUID.compareTo(GUID o)

### Description
Compares this GUID object with another GUID object.

### Method
`int`

### Parameters
* **o** (GUID) - The GUID object to compare against.

### Returns
* `int` - A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
```

```APIDOC
## GUID.setGuid(int[] guid)

### Description
Sets the GUID using an array of integers.

### Method
`GUID`

### Parameters
* **guid** (int[]) - An array of integers representing the GUID.
```

--------------------------------

### main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/fuzzing/cli/FuzzingCLI.html

The entry point for the FuzzingCLI application. This method is responsible for handling command-line arguments and initiating the fuzzing process.

```APIDOC
## main(String[] args)

### Description
Entry point for the FuzzingCLI application. Handles command-line arguments and starts the fuzzing process.

### Method
`public static void main(String[] args) throws Exception`

### Parameters
#### Path Parameters
- **args** (String[]) - The command-line arguments passed to the application.

### Throws
- `Exception` - If an error occurs during the execution of the main method.
```

--------------------------------

### main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/SpringExample.html

The entry point of the SpringExample application. This method can throw exceptions.

```APIDOC
## main(String[] args)

### Description
The entry point of the SpringExample application. This method can throw exceptions.

### Method
`public static void main(String[] args)`

### Throws
`Exception`
```

--------------------------------

### GUID Static Methods

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Details static methods available for creating and manipulating GUIDs.

```APIDOC
## GUID Static Methods

### fromCurlyBraceUTF16Bytes

#### Description
Converts a GUID of format: {AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE} (in bytes) to a GUID object.

#### Method
```java
public static GUID fromCurlyBraceUTF16Bytes(byte[] guid)
```

#### Parameters
* **guid** (byte[]) - The bytes that contains string in UTF-16 format of {AAAAAAAA-BBBB-CCCC-DDDD -EEEEEEEEEEEE}

#### Returns
GUID object parsed from guid bytes.

### memcmp

#### Description
Compares two integer arrays representing GUIDs.

#### Method
```java
public static int memcmp(int[] b1, int[] b2, int sz)
```

#### Parameters
* **b1** (int[]) - The first integer array.
* **b2** (int[]) - The second integer array.
* **sz** (int) - The number of elements to compare.

#### Returns
An integer indicating the result of the comparison.

### nil

#### Description
Returns a nil (all zeros) GUID.

#### Method
```java
public static GUID nil()
```

#### Returns
A nil GUID object.
```

--------------------------------

### GUID toByteArray Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Converts the GUID into a list of bytes. This is useful for serialization or transmission.

```java
public	List<Byte>	toByteArray()
```

--------------------------------

### StreamObjectHeaderStart16bit Constructors

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/fsshttpb/streamobj/StreamObjectHeaderStart16bit.html

Provides details on how to instantiate the StreamObjectHeaderStart16bit class.

```APIDOC
## StreamObjectHeaderStart16bit()

### Description
Initializes a new instance of the StreamObjectHeaderStart16bit class, this is the default constructor.

### Constructor
`public StreamObjectHeaderStart16bit()`
```

```APIDOC
## StreamObjectHeaderStart16bit(StreamObjectTypeHeaderStart type)

### Description
Initializes a new instance of the StreamObjectHeaderStart16bit class with a specified type.

### Parameters
* **type** (StreamObjectTypeHeaderStart) - Specify the type of the StreamObjectHeaderStart16bit.

### Throws
* `TikaException`

### Constructor
`public StreamObjectHeaderStart16bit(StreamObjectTypeHeaderStart type) throws TikaException`
```

```APIDOC
## StreamObjectHeaderStart16bit(StreamObjectTypeHeaderStart type, int length)

### Description
Initializes a new instance of the StreamObjectHeaderStart16bit class with specified type and length.

### Parameters
* **type** (StreamObjectTypeHeaderStart) - Specify the type of the StreamObjectHeaderStart16bit.
* **length** (int) - Specify the length of the StreamObjectHeaderStart16bit.

### Throws
* `TikaException`

### Constructor
`public StreamObjectHeaderStart16bit(StreamObjectTypeHeaderStart type, int length) throws TikaException`
```

--------------------------------

### ExGuid Constructors

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/fsshttpb/streamobj/basic/ExGuid.html

Provides details on how to initialize an ExGuid object.

```APIDOC
## ExGuid()

### Description
Initializes a new instance of the ExGuid class, this is a default constructor.

### Constructor
`public ExGuid()`
```

```APIDOC
## ExGuid(int value, UUID identifier)

### Description
Initializes a new instance of the ExGuid class with specified value.

### Parameters
* `value` (int) - Specify the ExGUID Value.
* `identifier` (UUID) - Specify the ExGUID GUID value.

### Constructor
`public ExGuid(int value, UUID identifier)`
```

```APIDOC
## ExGuid(ExGuid guid2)

### Description
Initializes a new instance of the ExGuid class, this is the copy constructor.

### Parameters
* `guid2` (ExGuid) - Specify the ExGuid instance where copies from.

### Constructor
`public ExGuid(ExGuid guid2)`
```

--------------------------------

### Start Table Event Handler

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/ooxml/OOXMLTikaBodyPartHandler.html

Handles the start of a table, potentially throwing a SAXException.

```java
public
void startTable()
                throws SAXException
```

--------------------------------

### Get Stateless Parser

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/extractor/EmbeddedDocumentUtil.html

Utility function to get the Parser that was sent in to the ParseContext to handle embedded documents. If it is stateful, unwrap it to get its stateless delegating parser. If there is no Parser in the parser context, this will return null.

```java
public static Parser getStatelessParser(ParseContext context)
```

--------------------------------

### Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/AbstractOfficeParser.html

Initializes a new instance of the AbstractOfficeParser class.

```APIDOC
## Constructor

### `AbstractOfficeParser()`

Initializes a new instance of the `AbstractOfficeParser` class.
```

--------------------------------

### StorageManifestSchemaGUID Field: guid

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/fsshttpb/streamobj/StorageManifestSchemaGUID.html

Declares the 'guid' field of type UUID within the StorageManifestSchemaGUID class.

```java
public
UUID guid
```

--------------------------------

### GeoParser Initialization

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/geo/topic/class-use/GeoParserConfig.html

Demonstrates how to initialize the GeoParser with a specific GeoParserConfig.

```APIDOC
## GeoParser.initialize

### Description
Initializes this parser with the provided GeoParserConfig.

### Method Signature
`void initialize(GeoParserConfig geoParserConfig)`

### Parameters
* **geoParserConfig** (GeoParserConfig) - The configuration object for the GeoParser.
```

--------------------------------

### initialize Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/recognition/tf/TensorflowImageRecParser.html

Initializes the recogniser with configuration parameters. This is the hook for setting up the recogniser and is part of the Initializable interface.

```java
public
void
initialize
(Map<String,
Param>
params)
throws TikaConfigException
```

--------------------------------

### GUID getGuidString Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Returns the GUID as a formatted string (e.g., "{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}").

```java
public String	getGuidString()
```

--------------------------------

### GUID toString Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Returns a string representation of the GUID. Overrides the default Object.toString method.

```java
public String	tosString()
```

--------------------------------

### SpringExample Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/SpringExample.html

Initializes a new instance of the SpringExample class.

```APIDOC
## SpringExample()

### Description
Initializes a new instance of the SpringExample class.

### Constructor
`public SpringExample()`
```

--------------------------------

### XPSTextExtractor Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/ooxml/xps/XPSTextExtractor.html

Initializes a new instance of the XPSTextExtractor class with the provided OPCPackage.

```APIDOC
## XPSTextExtractor Constructor

### Description
Initializes a new instance of the XPSTextExtractor class.

### Signature
```java
public XPSTextExtractor(org.apache.poi.openxml4j.opc.OPCPackage pkg)
```

### Parameters
* **pkg** (org.apache.poi.openxml4j.opc.OPCPackage) - The OPCPackage to initialize the extractor with.

### Throws
* `org.apache.poi.openxml4j.exceptions.OpenXML4JException`
* `org.apache.xmlbeans.XmlException`
* `IOException`
```

--------------------------------

### Activator start Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/internal/Activator.html

The start method required by the BundleActivator interface. It is called when the bundle is activated.

```java
public
void
start(org.osgi.framework.BundleContext
context)
throws Exception
```

--------------------------------

### startDocument() Methods

Source: https://tika.apache.org/3.2.3/api/index-all.html

The startDocument() method is called at the beginning of a document. It is implemented in various ContentHandler classes to perform initial setup.

```APIDOC
## startDocument()

### Description
Called at the beginning of a document. This method is implemented in various ContentHandler classes for initial setup.

### Class
- org.apache.tika.sax.TeeContentHandler
- org.apache.tika.sax.TextContentHandler
- org.apache.tika.sax.ToHTMLContentHandler
- org.apache.tika.sax.ToXMLContentHandler
- org.apache.tika.sax.XHTMLContentHandler
- org.apache.tika.sax.XMPContentHandler
```

--------------------------------

### Append GUID to BitWriter

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/fsshttpb/util/BitWriter.html

Appends a specified GUID value into the buffer. Ensure a UUID object is provided.

```java
public void appendGUID (UUID value)
```

--------------------------------

### GUID hashCode Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Returns a hash code value for the GUID. Overrides the default Object.hashCode method.

```java
public int	hashCode()
```

--------------------------------

### call() Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/StatusReporter.html

Starts up the reporter. This method is the main entry point for the reporter's execution, typically called when the reporter is run as a Callable.

```APIDOC
## call()

### Description
Startup the reporter.

Specified by:
`call` in interface `Callable<IFileProcessorFutureResult>`
```

--------------------------------

### Start Table Cell Event Handler

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/ooxml/OOXMLTikaBodyPartHandler.html

Handles the start of a table cell, potentially throwing a SAXException.

```java
public
void startTableCell()
                    throws SAXException
```

--------------------------------

### Start Table Row Event Handler

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/ooxml/OOXMLTikaBodyPartHandler.html

Handles the start of a table row, potentially throwing a SAXException.

```java
public
void startTableRow()
                   throws SAXException
```

--------------------------------

### TranslatorExample Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/TranslatorExample.html

Initializes a new instance of the TranslatorExample class.

```APIDOC
## TranslatorExample()

### Description
Initializes a new instance of the TranslatorExample class.

### Constructor
`TranslatorExample()`
```

--------------------------------

### newInstance(Class klass, ServiceLoader loader)

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/utils/ServiceLoaderUtils.html

Loads a class and instantiates it, attempting to use the ServiceLoader constructor if available, otherwise falling back to a zero-argument constructor.

```APIDOC
## newInstance(Class klass, ServiceLoader loader)

### Description
Loads a class and instantiates it. If the class can be initialized with a ServiceLoader, the ServiceLoader constructor is used. Otherwise, a zero-arg newInstance() is called.

### Method Signature
`public static <T> T newInstance(Class klass, ServiceLoader loader)`

### Parameters
* `klass` (Class) - The class to build.
* `loader` (ServiceLoader) - The ServiceLoader to use for instantiation.

### Returns
An instance of the specified class `T`.
```

--------------------------------

### GUID nil Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/onenote/GUID.html

Returns a static, null GUID object. This is often used as a default or placeholder value.

```java
public static	GUID	nil()
```

--------------------------------

### MediaTypeExample Methods

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/MediaTypeExample.html

This section details the static methods available in the MediaTypeExample class.

```APIDOC
## describeMediaType()

### Description
Describes a media type.

### Method
`static void`

### Endpoint
N/A (Java method)

### Parameters
None

### Request Example
N/A

### Response
N/A
```

```APIDOC
## listAllTypes()

### Description
Lists all available media types.

### Method
`static void`

### Endpoint
N/A (Java method)

### Parameters
None

### Request Example
N/A

### Response
N/A
```

```APIDOC
## main(String[] args)

### Description
Main method to execute the MediaTypeExample.

### Method
`static void`

### Endpoint
N/A (Java method)

### Parameters
- **args** (String[]) - Command line arguments.

### Request Example
N/A

### Response
N/A

### Throws
- `Exception`
```

--------------------------------

### HttpFetcherConfig - Get Password

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/fetcher/http/config/HttpFetcherConfig.html

Retrieves the configured password for authentication. Use this method to get the current password setting.

```java
public String getPassword()
```

--------------------------------

### newInstance(String className)

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/utils/ServiceLoaderUtils.html

Loads a class by its name and instantiates it.

```APIDOC
## newInstance(String className)

### Description
Loads a class and instantiates it.

### Method Signature
`public static <T> T newInstance(String className)`

### Parameters
* `className` (String) - The fully qualified name of the class to load and instantiate.

### Returns
An instance of the specified class `T`.
```

--------------------------------

### Get Long Values from Metadata Property

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/metadata/Metadata.html

Gets the array of longs from the identified 'seq' integer metadata property.

```APIDOC
## getLongValues

### Description
Gets the array of ints of the identified "seq" integer metadata property.

### Method Signature
```java
public long[] getLongValues(Property property)
```

### Parameters
* `property` - seq integer property definition

### Returns
array of ints

### Since
Apache Tika 1.21
```

--------------------------------

### Get Integer Values from Metadata Property

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/metadata/Metadata.html

Gets the array of integers from the identified 'seq' integer metadata property.

```APIDOC
## getIntValues

### Description
Gets the array of ints of the identified "seq" integer metadata property.

### Method Signature
```java
public int[] getIntValues(Property property)
```

### Parameters
* `property` - seq integer property definition

### Returns
array of ints

### Since
Apache Tika 1.21
```

--------------------------------

### BatchTopCommonTokenCounter Main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/eval/app/tools/BatchTopCommonTokenCounter.html

The entry point for the BatchTopCommonTokenCounter utility. It runs TopCommonTokenCounter against a directory of table files and outputs common tokens.

```APIDOC
## main(String[] args)

### Description
Utility class that runs TopCommonTokenCounter against a directory of table files (named {lang}_table.gz or leipzip-like afr_...-sentences.txt) and outputs common tokens files for each input table file in the output directory.

### Method
`public static void main(String[] args)`

### Throws
`Exception`
```

--------------------------------

### Get Identified Language

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/langdetect/tika/LanguageIdentifier.html

Gets the ISO 639 code representing the language that was identified for the content provided to the LanguageIdentifier.

```java
public String getLanguage()
```

--------------------------------

### Start Paragraph Event Handler

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/ooxml/OOXMLTikaBodyPartHandler.html

Handles the start of a paragraph, processing paragraph properties and potentially throwing a SAXException.

```java
public
void startParagraph(ParagraphProperties paragraphProperties)
                    throws SAXException
```

--------------------------------

### main

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/gui/TikaGUI.html

The main method to launch the TikaGUI application.

```APIDOC
## main

### Description
Main method to launch the TikaGUI application.

### Method
`static void main(String[] args)`
```

--------------------------------

### main Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/example/RollbackSoftware.html

The main entry point for the RollbackSoftware application.

```APIDOC
## Method main

### Description
The main entry point for the RollbackSoftware application.

### Method
`static void main(String[] args)`

### Throws
`Exception`
```

--------------------------------

### Hyperlink Start Event Handler

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/microsoft/ooxml/OOXMLTikaBodyPartHandler.html

Handles the start of a hyperlink, processing the link URL and potentially throwing a SAXException.

```java
public
void hyperlinkStart(String link)
                    throws SAXException
```

--------------------------------

### OpenSearchPipesReporter initialize Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/reporters/opensearch/OpenSearchPipesReporter.html

Initializes the reporter with provided parameters. Throws TikaConfigException if initialization fails.

```java
public
void
initialize(Map<String, Param> params)
                throws TikaConfigException
```

--------------------------------

### HttpFetcherConfig - Get User Name

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/fetcher/http/config/HttpFetcherConfig.html

Retrieves the configured username for authentication. Use this method to get the current username setting.

```java
public String getUserName()
```

--------------------------------

### usage Method

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/batch/fs/FSBatchProcessCLI.html

Displays the usage instructions for the FSBatchProcessCLI command-line tool.

```APIDOC
## usage()

### Description
Prints the command-line usage instructions for the FSBatchProcessCLI.
```

--------------------------------

### Start XMP Description

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/sax/XMPContentHandler.html

Starts a description block within the XMP document. This method is used to define the scope of properties.

```java
public
void startDescription(String about,
                             String prefix,
                             String uri)
                      throws SAXException


Throws:
    SAXException
```

--------------------------------

### initialize(Map<String, Param> params)

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/emitter/gcs/GCSEmitter.html

Initializes the GCS client with the provided parameters.

```APIDOC
## initialize(Map<String, Param> params)

### Description
Initializes the GCS client with the provided parameters.

### Method
```java
public void initialize(Map<String, Param> params)
```

### Parameters
* `params` (Map<String, Param>) - Parameters for initialization.

### Throws
* `TikaConfigException`
```

--------------------------------

### AZBlobFetcher Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/fetcher/azblob/config/class-use/AZBlobFetcherConfig.html

Demonstrates how to instantiate AZBlobFetcher using an AZBlobFetcherConfig object.

```APIDOC
## AZBlobFetcher(AZBlobFetcherConfig azBlobFetcherConfig)

### Description
Constructs an AZBlobFetcher with the specified configuration.

### Parameters
#### Path Parameters
- **azBlobFetcherConfig** (AZBlobFetcherConfig) - Required - The configuration object for the Azure Blob Fetcher.
```

--------------------------------

### Start XHTML Element with Attributes

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/sax/XHTMLContentHandler.html

Starts an element, automatically indenting table cells and list items with a tab character.

```java
public void startElement(String uri,
                         String local,
                         String name,
                         Attributes attributes)
                  throws SAXException
```

--------------------------------

### Method to Set Start Bookmark

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/pdf/PDFMarkedContent2XHTML.html

Sets the start bookmark for a PDF outline item. Used for navigation within the document.

```java
void setStartBookmark(org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem pdOutlineItem)
```

--------------------------------

### StartXRefOffset Constructor

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/pdf/updates/StartXRefOffset.html

Initializes a new instance of the StartXRefOffset class with the provided PDF offset information.

```APIDOC
## StartXRefOffset Constructor

### Description
Initializes a new instance of the `StartXRefOffset` class.

### Parameters
* `startxref` (long) - The value of the startxref pointer.
* `startXrefOffset` (long) - The offset in the file for where the startxref string is located.
* `endEofOffset` (long) - The offset in the file for where the EOF ends, including a trailing newline if present.
* `hasEof` (boolean) - Indicates whether an EOF marker was found.
```

--------------------------------

### Loading PipesConfig

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/pipes/class-use/PipesConfig.html

Demonstrates how to load PipesConfig from an InputStream or a Path.

```APIDOC
## Load PipesConfig

### Description
Loads the PipesConfig from a given InputStream or Path.

### Methods
- `static PipesConfig load(InputStream tikaConfigInputStream)`
- `static PipesConfig load(Path tikaConfig)`
```

--------------------------------

### Override for Writing Paragraph Start

Source: https://tika.apache.org/3.2.3/api/org/apache/tika/parser/pdf/PDFMarkedContent2XHTML.html

Handles the writing of a paragraph start marker. This method can be overridden to customize paragraph formatting.

```java
protected void writeParagraphStart()
```
Tokens:
Raw