NativeLibSettings

Inheritance: java.lang.Object

public class NativeLibSettings

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.

Methods

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

clearAsposeNativeTmpDirectory()

public static void clearAsposeNativeTmpDirectory()

Clears the directory where Aspose temporary libraries are stored.

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: boolean - is the thread should be interrupted on image exceptions.

getTmpDirectoryPath()

public static String getTmpDirectoryPath()

Return the path to the temporary directory of native libraries.

Returns: java.lang.String

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: boolean - is JAI used.

isHarfBuzzNativeLibLoaded()

public static boolean isHarfBuzzNativeLibLoaded()

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

Returns: boolean

isWinNativeLibLoaded()

public static boolean isWinNativeLibLoaded()

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

Returns: boolean

loadHarfBuzzNativeLib()

public static void loadHarfBuzzNativeLib()

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

loadWinNativeLib()

public static void loadWinNativeLib()

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

setInterruptThreadIfImageExceptionThrown(boolean abortSavingIfImageExceptionThrown)

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:

ParameterTypeDescription
abortSavingIfImageExceptionThrownbooleantrue - interrupt thread on image exceptions, false - do not interrupt

setTmpDirectoryPath(String path)

public static void setTmpDirectoryPath(String path)

Specifies the path to the temporary directory of native libraries.

Parameters:

ParameterTypeDescription
pathjava.lang.Stringthe path to the temporary directory of native libraries.

setUseJAIImageRendering(boolean useJAIImageRendering)

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:

ParameterTypeDescription
useJAIImageRenderingbooleanis it necessary to use JAI.

skipHarfBuzzNativeLib()

public static void skipHarfBuzzNativeLib()

Skip loading 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.