com.aspose.words

Class NativeLibSettings

java.lang.Object

com.aspose.words.NativeLibSettings

public class NativeLibSettings
extends java.lang.Object

This class helps to set various options such as temporary folder for Aspose.Words native libraries and whether native libraries should be loaded and used.

Method Summary

Modifier and Type	Method and Description
static void	clearAsposeNativeTmpDirectory() Clears the directory where Aspose temporary libraries are stored.
static boolean	getInterruptThreadIfImageExceptionThrown() Returns the current value of the property that controls thread interruption on image exceptions.
static java.lang.String	getTmpDirectoryPath() Return the path to the temporary directory of native libraries.
static boolean	getUseJAIImageRendering() Gets a value that determines whether JAI (Java Advanced Imaging) is employed during the rendering of document images.
static boolean	isHarfBuzzNativeLibLoaded() Returns true if HarfBuzz libraries is loaded.
static boolean	isWinNativeLibLoaded() Returns true if WindowsNativeCall libraries is loaded.
static void	loadHarfBuzzNativeLib() Sets to load and use harfbuzz-shaping-engine-dll.dll libraries.
static void	loadWinNativeLib() Sets to load and use WindowsNativeCall_x86|_x64.dll libraries.
static void	setInterruptThreadIfImageExceptionThrown(boolean abortSavingIfImageExceptionThrown) Sets the property that defines behavior when handling image exceptions.
static void	setTmpDirectoryPath(java.lang.String path) Specifies the path to the temporary directory of native libraries.
static void	setUseJAIImageRendering(boolean useJAIImageRendering) Sets a value that determines whether JAI (Java Advanced Imaging) is employed during the rendering of document images.
static void	skipHarfBuzzNativeLib() Skip loading and use harfbuzz-shaping-engine-dll.dll libraries.
static void	skipWinNativeLib() Skip loading and use WindowsNativeCall_x86|_x64.dll libraries.

Methods inherited from class java.lang.Object

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

Method Detail

setTmpDirectoryPath

public static void setTmpDirectoryPath(java.lang.String path)
                                throws java.lang.IllegalArgumentException

Specifies the path to the temporary directory of native libraries.

Parameters:

path - the path to the temporary directory of native libraries.

Throws:

java.lang.IllegalArgumentException - if path is invalid.

getTmpDirectoryPath

public static java.lang.String getTmpDirectoryPath()

Return the path to the temporary directory of native libraries.

clearAsposeNativeTmpDirectory

public static void clearAsposeNativeTmpDirectory()

Clears the directory where Aspose temporary libraries are stored.

loadWinNativeLib

public static void loadWinNativeLib()

Sets to load and use WindowsNativeCall_x86|_x64.dll libraries. By default, native libraries are loaded.

loadHarfBuzzNativeLib

public static void loadHarfBuzzNativeLib()

Sets to load and use harfbuzz-shaping-engine-dll.dll libraries. By default, native libraries are loaded.

skipWinNativeLib

public static void skipWinNativeLib()

Skip loading and use WindowsNativeCall_x86|_x64.dll libraries. By default, native libraries are loaded.

skipHarfBuzzNativeLib

public static void skipHarfBuzzNativeLib()

Skip loading and use harfbuzz-shaping-engine-dll.dll libraries. By default, native libraries are loaded.

isWinNativeLibLoaded

public static boolean isWinNativeLibLoaded()

Returns true if WindowsNativeCall libraries is loaded. By default, native libraries are loaded.

isHarfBuzzNativeLibLoaded

public static boolean isHarfBuzzNativeLibLoaded()

Returns true if HarfBuzz libraries is loaded. By default, native libraries are loaded.

setUseJAIImageRendering

public static void setUseJAIImageRendering(boolean useJAIImageRendering)

Sets a value that determines whether JAI (Java Advanced Imaging) is employed during the rendering of document images. In some cases, this may improve performance.

Remarks:

The default value is true.

JAI will only be utilized if it is included as a dependency as described here. Certain images might not render correctly if JAI is disabled.

Parameters:

useJAIImageRendering - is it necessary to use JAI.

getUseJAIImageRendering

public static boolean getUseJAIImageRendering()

Gets a value that determines whether JAI (Java Advanced Imaging) is employed during the rendering of document images. In some cases, this may improve performance.

Remarks:

The default value is true.

JAI will only be utilized if it is included as a dependency as described here. Certain images might not render correctly if JAI is disabled.

Returns:

is JAI used.

setInterruptThreadIfImageExceptionThrown

public static void setInterruptThreadIfImageExceptionThrown(boolean abortSavingIfImageExceptionThrown)

Sets the property that defines behavior when handling image exceptions. If the property is set to true, the execution thread will be interrupted when an exception occurs during image processing.

Remarks:

The default value is false.

Parameters:

abortSavingIfImageExceptionThrown - true - interrupt thread on image exceptions, false - do not interrupt

getInterruptThreadIfImageExceptionThrown

public static boolean getInterruptThreadIfImageExceptionThrown()

Returns the current value of the property that controls thread interruption on image exceptions.

Remarks:

The default value is false.

Returns:

is the thread should be interrupted on image exceptions.