com.aspose.pdf

Class MemoryExtender

java.lang.Object

com.aspose.pdf.MemoryExtender

public class MemoryExtender
extends Object

Represents MemoryExtender class Using large files on a system with limited heap memory, can be enabled to use disk space as a temporary swap memory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MemoryExtender.CallBackPageImage The call back procedure for manipulating the cache.

Constructor Summary

Constructors

Constructor and Description
MemoryExtender()

Method Summary

Modifier and Type	Method and Description
static MemoryExtender.CallBackPageImage	getCallBackPageImage() Get the custom cache analyzer.
static int	getElementRenderingTimeout() The maximum time for rendering single element used in page to image conversion.
static boolean	isEnabledMultiPageImageCache() Get the status for EnabledMultiPageImageCache field
static boolean	isOptimizedMemoryStreamByDefault() Is enabled to use OptimizedMemoryStream as default memory storage.
static void	isOptimizedMemoryStreamByDefault(boolean value) Is enabled to use OptimizedMemoryStream as default memory storage.
static boolean	isSkipHeavyContentEnabled() Is enabled to skip objects with high memory consumption in rendering with lack of heap memory.
static boolean	isSwapEnabled() Is enabled to use disk space as a temporary swap memory.
static boolean	isTryToCreateFolderIfAbsent() Gets a value indicating whether missing folders should be automatically created.
static void	setCallBackPageImage(MemoryExtender.CallBackPageImage callBackPageImage_) Apply the new custom cache analyzer.
static void	setElementRenderingTimeout(int value) The maximum time for rendering single element used in page to image conversion.
static void	setEnableMultiPageCache(boolean enableMultiPageImageCache_) Set the new status for EnabledMultiPageImageCache field
static void	setSkipHeavyContentEnabled(boolean value) Set flag to enable to skip objects with high memory consumption in rendering with lack of heap memory.
static void	setSwapEnabled(boolean value) Set flag whether disk space is enabled to use as a temporary swap memory.
static void	setTryToCreateFolderIfAbsent(boolean value) Sets a value indicating whether missing folders should be automatically created.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryExtender

public MemoryExtender()

Method Detail

isSwapEnabled

public static boolean isSwapEnabled()

Is enabled to use disk space as a temporary swap memory. Default value is FALSE

Returns:

boolean value

isOptimizedMemoryStreamByDefault

public static boolean isOptimizedMemoryStreamByDefault()

Is enabled to use OptimizedMemoryStream as default memory storage. Required for work with large documents over 2 Gb. Default value is FALSE

Returns:

boolean value

isOptimizedMemoryStreamByDefault

public static void isOptimizedMemoryStreamByDefault(boolean value)

Is enabled to use OptimizedMemoryStream as default memory storage. Required for work with large documents over 2 Gb. Default value is FALSE

Parameters:

value - boolean value

setSwapEnabled

public static void setSwapEnabled(boolean value)

Set flag whether disk space is enabled to use as a temporary swap memory.

Parameters:

value - boolean value

isSkipHeavyContentEnabled

public static boolean isSkipHeavyContentEnabled()

Is enabled to skip objects with high memory consumption in rendering with lack of heap memory. Default value is FALSE

Returns:

boolean value

setSkipHeavyContentEnabled

public static void setSkipHeavyContentEnabled(boolean value)

Set flag to enable to skip objects with high memory consumption in rendering with lack of heap memory.

Parameters:

value - boolean value

getElementRenderingTimeout

public static int getElementRenderingTimeout()

The maximum time for rendering single element used in page to image conversion. Default value 10000 milliseconds. Used only when isSkipHeavyContentEnabled() == true

Returns:

int value Number of milliseconds

setElementRenderingTimeout

public static void setElementRenderingTimeout(int value)

The maximum time for rendering single element used in page to image conversion. Default value 10000 milliseconds Used only when isSkipHeavyContentEnabled() == true

Parameters:

value - int value Number of milliseconds

getCallBackPageImage

public static MemoryExtender.CallBackPageImage getCallBackPageImage()

Get the custom cache analyzer.

Returns:

CallBackPageImage object

setCallBackPageImage

public static void setCallBackPageImage(MemoryExtender.CallBackPageImage callBackPageImage_)

Apply the new custom cache analyzer.

Parameters:

callBackPageImage_ - CallBackPageImage object

isEnabledMultiPageImageCache

public static boolean isEnabledMultiPageImageCache()

Get the status for EnabledMultiPageImageCache field

Returns:

boolean value

setEnableMultiPageCache

public static void setEnableMultiPageCache(boolean enableMultiPageImageCache_)

Set the new status for EnabledMultiPageImageCache field

Parameters:

enableMultiPageImageCache_ - boolean value

isTryToCreateFolderIfAbsent

public static boolean isTryToCreateFolderIfAbsent()

Gets a value indicating whether missing folders should be automatically created.

If set to true, Aspose methods that save by path will attempt to create the target folder structure if it does not already exist.

The default value is false.

Returns:

boolean value

setTryToCreateFolderIfAbsent

public static void setTryToCreateFolderIfAbsent(boolean value)

Sets a value indicating whether missing folders should be automatically created.

If set to true, Aspose methods that save by path will attempt to create the target folder structure if it does not already exist.

The default value is false.

Parameters:

value - boolean value