TextPatternScanner

java.lang.Object
- io.scanbot.sdk.textpattern.TextPatternScanner

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class TextPatternScanner
extends java.lang.Object
implements java.lang.AutoCloseable
```
API for text pattern scanning. Required licence feature(s): TextPatternScanner.

Constructor Summary

Constructors
Constructor Description

TextPatternScanner(TextPatternScannerConfiguration configuration)
Constructs TextPatternScanner with the given params.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cleanRecognitionQueue()`	Clean the queue of recognize text lines.
`void`	`close()`	Closes native resources held by the object.
`protected void`	`finalize()`
`TextPatternScannerResult`	`run(ImageRef image)`	Recognize text line in the given image.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TextPatternScanner
```
public TextPatternScanner(TextPatternScannerConfiguration configuration)
                   throws LicenseException
```
    Constructs TextPatternScanner with the given params.
    
    Parameters:
    
    configuration - The configuration to use for the generic text line scanner.
    
    Throws:
    
    LicenseException - If license requirements for the API are not met
- Method Detail
  - run
```
public TextPatternScannerResult run(ImageRef image)
                             throws InvalidImageRefException,
                                    LicenseException
```
    Recognize text line in the given image.
    
    Parameters:
    
    image - The image to recognize text line in.
    
    Returns:
    
    The recognized text line.
    
    Throws:
    
    InvalidImageRefException - If an invalid image reference is used
    
    LicenseException - If license requirements for the API are not met
  - cleanRecognitionQueue
```
public void cleanRecognitionQueue()
```
    Clean the queue of recognize text lines.
  - close
```
public void close()
```
    Closes native resources held by the object.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable