com.myscript.iink

Class Engine

java.lang.Object

com.myscript.iink.Engine

All Implemented Interfaces:

IAutoCloseable

public class Engine
extends java.lang.Object
implements IAutoCloseable

Represents the iink runtime environment.

Method Summary

Modifier and Type	Method and Description
void	close() Deletes native counterpart of this auto closable object
static Engine	create(byte[] certificate) Creates a new engine.
Editor	createEditor(Renderer renderer) Creates a new editor.
ContentPackage	createPackage(java.io.File file) Creates a new package.
ContentPackage	createPackage(java.lang.String path) Creates a new package.
ParameterSet	createParameterSet() Creates a new empty parameter set.
RecognitionAssetsBuilder	createRecognitionAssetsBuilder() Creates a new RecognitionAssetsBuilder.
Renderer	createRenderer(float dpiX, float dpiY, IRenderTarget renderTarget) Creates a new renderer.
void	deletePackage(java.io.File file) Deletes the specified package.
void	deletePackage(java.lang.String path) Deletes the specified package.
Configuration	getConfiguration() Returns the configuration associated with this engine.
java.lang.String[]	getSupportedPartTypes() Returns the set of content part types that this engine can handle.
boolean	isClosed() Tells whether the close() method has been called.
ContentPackage	openPackage(java.io.File file) Opens the specified package using the EXISTING package open option.
ContentPackage	openPackage(java.io.File file, PackageOpenOption openOption) Opens the specified package.
ContentPackage	openPackage(java.lang.String path) Opens the specified package using the EXISTING package open option.
ContentPackage	openPackage(java.lang.String path, PackageOpenOption openOption) Opens the specified package.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static final Engine create(byte[] certificate)
                           throws java.lang.IllegalArgumentException

Creates a new engine.

Note: make sure to close the returned object.

Parameters:

certificate - the certificate that identifies you as a valid MyScript technology integrator.

Returns:

the newly created engine.

Throws:

java.lang.IllegalArgumentException - when the certificate is invalid.

close

public final void close()

Description copied from interface: IAutoCloseable

Deletes native counterpart of this auto closable object

Specified by:

close in interface IAutoCloseable

isClosed

public final boolean isClosed()

Tells whether the close() method has been called. Once an object is closed any method will throw IllegalStateException.

Returns:

true if this object is closed.

getConfiguration

public final Configuration getConfiguration()

Returns the configuration associated with this engine.

Note: do not close the returned object as it is owned by the engine.

Returns:

the engine configuration.

createPackage

public final ContentPackage createPackage(java.io.File file)
                                   throws java.io.IOException

Creates a new package.

Note: make sure to close the returned object.

Parameters:

file - the package file.

Returns:

the package.

Throws:

java.io.IOException - if a package with associated filename already exists.

java.io.IOException - if an I/O operation fails.

java.lang.IllegalArgumentException - if a package associated with the same filename is already opened, it can be accessed via a call to openPackage().

createPackage

public final ContentPackage createPackage(java.lang.String path)
                                   throws java.io.IOException

Creates a new package.

Note: make sure to close the returned object.

Parameters:

path - the package file path.

Returns:

the package.

Throws:

java.io.IOException - if a package with associated filename already exists.

java.io.IOException - if an I/O operation fails.

java.lang.IllegalArgumentException - if a package associated with the same filename is already opened, it can be accessed via a call to openPackage().

openPackage

public final ContentPackage openPackage(java.io.File file)
                                 throws java.io.IOException

Opens the specified package using the EXISTING package open option.

Note: make sure to close the returned object.

Parameters:

file - the package file.

Returns:

the package.

Throws:

java.io.IOException - if a package with associated filename does not exist.

java.io.IOException - if an I/O operation fails.

openPackage

public final ContentPackage openPackage(java.io.File file,
                                        PackageOpenOption openOption)
                                 throws java.io.IOException

Opens the specified package.

Note: make sure to close the returned object.

Parameters:

file - the package file.

openOption - the open option used to open the package file.

Returns:

the package.

Throws:

java.io.IOException - when openOption is EXISTING, if a package with associated filename does not exist.

java.io.IOException - when openOption is CREATE_NEW, if a package with associated filename already exists.

java.lang.IllegalArgumentException - when openOption is CREATE_NEW, if a package associated with the same filename is already opened.

java.io.IOException - if an I/O operation fails.

Since:

1.2

openPackage

public final ContentPackage openPackage(java.lang.String path)
                                 throws java.io.IOException

Opens the specified package using the EXISTING package open option.

Note: make sure to close the returned object.

Parameters:

path - the package file path.

Returns:

the package.

Throws:

java.io.IOException - if a package with associated filename does not exist.

java.io.IOException - if an I/O operation fails.

openPackage

public final ContentPackage openPackage(java.lang.String path,
                                        PackageOpenOption openOption)
                                 throws java.io.IOException

Opens the specified package.

Note: make sure to close the returned object.

Parameters:

path - the package file path.

openOption - the open option used to open the package file.

Returns:

the package.

Throws:

java.io.IOException - when openOption is EXISTING, if a package with associated filename does not exist.

java.io.IOException - when openOption is CREATE_NEW, if a package with associated filename already exists.

java.lang.IllegalArgumentException - when openOption is CREATE_NEW, if a package associated with the same filename is already opened.

java.io.IOException - if an I/O operation fails.

Since:

1.2

deletePackage

public final void deletePackage(java.io.File file)
                         throws java.io.IOException,
                                java.lang.IllegalArgumentException

Deletes the specified package.

Parameters:

file - the package file.

Throws:

java.io.IOException - if an I/O operation fails.

java.lang.IllegalArgumentException - when a package associated with the same fileName is already opened.

Since:

1.2

deletePackage

public final void deletePackage(java.lang.String path)
                         throws java.io.IOException,
                                java.lang.IllegalArgumentException

Deletes the specified package.

Parameters:

path - the package file path.

Throws:

java.io.IOException - if an I/O operation fails.

java.lang.IllegalArgumentException - when a package associated with the same fileName is already opened.

Since:

1.2

createRenderer

public final Renderer createRenderer(float dpiX,
                                     float dpiY,
                                     IRenderTarget renderTarget)

Creates a new renderer.

Note: make sure to close the returned object.

Parameters:

dpiX - the physical horizontal resolution of the display in dots per inch.

dpiY - the physical vertical resolution of the display in dots per inch.

renderTarget - the render target.

Returns:

the newly created renderer.

Throws:

java.lang.IllegalArgumentException - when dpiX is not a number.

java.lang.IllegalArgumentException - when dpiX is negative.

java.lang.IllegalArgumentException - when dpiY is not a number.

java.lang.IllegalArgumentException - when dpiY is negative.

createEditor

public final Editor createEditor(Renderer renderer)

Creates a new editor.

Parameters:

renderer - the renderer to be used to display editor's content.

Returns:

the newly created editor.

getSupportedPartTypes

public final java.lang.String[] getSupportedPartTypes()

Returns the set of content part types that this engine can handle.

Returns:

an unmodifiable set of the handled content type names.

createParameterSet

public final ParameterSet createParameterSet()

Creates a new empty parameter set.

Returns:

the newly created parameter set.

createRecognitionAssetsBuilder

public final RecognitionAssetsBuilder createRecognitionAssetsBuilder()

Creates a new RecognitionAssetsBuilder.

Returns:

the newly created recognition assets builder.

Since:

1.2.4