com.groupdocs.viewer.caching

Class FileCache

java.lang.Object

com.groupdocs.viewer.caching.FileCache

All Implemented Interfaces:

Cache

public class FileCache
extends Object
implements Cache

Represents a local on-disk cache.

The FileCache class represents a local on-disk cache in the GroupDocs.Viewer component. It provides functionality to store and retrieve cached data on the disk for efficient document rendering.

Example usage:

 FileCache fileCache = new FileCache(cachePath, cacheSubFolder);

 final ViewerSettings viewerSettings = new ViewerSettings();
 viewerSettings.setCache(fileCache);

 try (Viewer viewer = new Viewer(documentPath, viewerSettings)) {
     // Use the viewer object for document rendering
 }
 

To use the FileCache, you need to create an instance of this class and pass it to the ViewerSettings object. The Viewer object will then use the FileCache for caching purposes while rendering documents.

Note: The FileCache is just one of the cache implementations provided by GroupDocs.Viewer. You can also implement your own custom cache by implementing the Cache interface.

See Also:

ViewerSettings, Viewer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_PATH

Constructor Summary

Constructors

Constructor and Description
FileCache(Path cachePath) Creates a new instance of the FileCache class.
FileCache(Path cachePath, String cacheSubFolder) Creates a new instance of the FileCache class.
FileCache(String cachePath) Creates a new instance of the FileCache class.
FileCache(String cachePath, String cacheSubFolder) Creates a new instance of the FileCache class.

Method Summary

Modifier and Type	Method and Description
<T> T	get(String key, Class<T> clazz) Deserializes data associated with this key if present.
String	getCachePath() Gets the relative or absolute path to the cache folder.
String	getCacheSubFolder() The sub-folder to append to the cache path.
List<String>	getKeys(String filter) Returns all file names that contain the filter in the filename.
void	set(String key, Object value) Serializes data to the local disk.

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_PATH

public static final String CACHE_PATH

See Also:

Constant Field Values

Constructor Detail

FileCache

public FileCache(Path cachePath)

Creates a new instance of the FileCache class.

Parameters:

cachePath - The relative or absolute path where the document cache will be stored.

Throws:

IllegalArgumentException - Thrown when cachePath is null.

FileCache

public FileCache(Path cachePath,
                 String cacheSubFolder)

Creates a new instance of the FileCache class.

Parameters:

cachePath - The relative or absolute path where the document cache will be stored.

cacheSubFolder - The sub-folder to append to cachePath.

Throws:

IllegalArgumentException - Thrown when cachePath is null.

IllegalArgumentException - Thrown when cacheSubFolder is null.

FileCache

public FileCache(String cachePath)

Creates a new instance of the FileCache class.

Parameters:

cachePath - The relative or absolute path where the document cache will be stored.

Throws:

IllegalArgumentException - Thrown when cachePath is null.

FileCache

public FileCache(String cachePath,
                 String cacheSubFolder)

Creates a new instance of the FileCache class.

Parameters:

cachePath - The relative or absolute path where the document cache will be stored.

cacheSubFolder - The sub-folder to append to cachePath.

Throws:

IllegalArgumentException - Thrown when cachePath is null.

IllegalArgumentException - Thrown when cacheSubFolder is null.

Method Detail

get

public final <T> T get(String key,
                       Class<T> clazz)

Deserializes data associated with this key if present.

Specified by:

get in interface Cache

Parameters:

key - A key identifying the requested entry.

clazz - The class of the expected value.

Returns:

the located value or null.

getCachePath

public final String getCachePath()

Gets the relative or absolute path to the cache folder.

Returns:

Path to the cache folder.

getCacheSubFolder

public final String getCacheSubFolder()

The sub-folder to append to the cache path.

Returns:

the sub-folder to append.

getKeys

public final List<String> getKeys(String filter)

Returns all file names that contain the filter in the filename.

Specified by:

getKeys in interface Cache

Parameters:

filter - The filter to use.

Returns:

File names that contain the filter in the filename.

set

public final void set(String key,
                      Object value)

Serializes data to the local disk.

Specified by:

set in interface Cache

Parameters:

key - The unique identifier for the cache entry.

value - The object to serialize.