com.groupdocs.viewer.caching

Interface Cache

All Known Implementing Classes:

FileCache

public interface Cache

Defines methods required for storing rendered documents and document resources cache.

The Cache interface defines the methods required for storing rendered documents and document resources cache in the GroupDocs.Viewer component. It provides a contract for implementing different cache mechanisms to enhance the performance of document rendering by caching frequently accessed data.

Example usage:

 // Implement a custom cache by implementing the Cache interface
 public class MyCustomCache implements Cache {
     // Implement the methods of the Cache interface based on your caching mechanism
     // ...
 }

 // Create an instance of your custom cache
 Cache myCache = new MyCustomCache();

 final ViewerSettings viewerSettings = new ViewerSettings();
 // Set the custom cache to viewerSettings
 viewerSettings.setCache(myCache);

 // Use the viewerSettings object for creating Viewer object to render document with custom cache
 try (Viewer viewer = new Viewer(documentPath, viewerSettings)) {
     // Use the viewer object for document rendering
 }
 

Note: The Cache interface allows you to implement custom cache mechanisms tailored to your specific requirements. GroupDocs.Viewer also provides built-in cache implementation such as FileCache.

See Also:

Viewer, ViewerSettings, FileCache

Method Summary

Modifier and Type	Method and Description
<T> T	get(String key, Class<T> clazz) Retrieves the entry associated with the specified key if it is present, and returns null otherwise.
List<String>	getKeys(String filter) Returns all keys that match the specified filter.
void	set(String key, Object value) Inserts a cache entry into the cache.

Method Detail

get

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

Retrieves the entry associated with the specified key if it is present, and returns null otherwise.

Parameters:

key - A key identifying the requested entry.

clazz - The class type of the expected entry.

Returns:

the entry associated with the key if found, or null otherwise.

getKeys

List<String> getKeys(String filter)

Returns all keys that match the specified filter.

Parameters:

filter - The filter to use.

Returns:

a list of keys that match the filter.

set

void set(String key,
         Object value)

Inserts a cache entry into the cache.

Parameters:

key - A unique identifier for the cache entry.

value - The object to insert.