main.java.com.djrapitops.plan.systems.webserver

Class PageCache

java.lang.Object

main.java.com.djrapitops.plan.systems.webserver.PageCache

public class PageCache
extends Object

This class contains the page cache.

It caches all Responses with their matching identifiers. This reduces CPU cycles and the time to wait for loading the pages. This is especially useful in situations where multiple clients are accessing the server.

This cache uses the Google Guava Cache.

Since:

3.6.0

Author:

Fuzzlemann

Method Summary

Modifier and Type	Method and Description
static void	cachePage(String identifier, PageLoader loader) Puts the page into the page cache.
static void	clearCache() Clears the cache from all its contents.
static boolean	isCached(String identifier) Checks if the page is cached.
static Response	loadPage(String identifier) Loads the page from the page cache.
static Response	loadPage(String identifier, PageLoader loader) Loads the page from the page cache.
static void	removeIf(Predicate<String> filter) Removes all of the elements of this cache that satisfy the given predicate.

Methods inherited from class java.lang.Object

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

Method Detail

loadPage

public static Response loadPage(String identifier,
                                PageLoader loader)

Loads the page from the page cache.

If the Response isn't cached, PageLoader.createResponse() in the loader is called to create the Response.

If the Response is created, it's automatically cached.

Parameters:

identifier - The identifier of the page

loader - The PageLoader (How should it load the page if it's not cached)

Returns:

The Response that was cached or created by the loader

loadPage

public static Response loadPage(String identifier)

Loads the page from the page cache.

Parameters:

identifier - The identifier of the page

Returns:

The Response that was cached or null if it wasn't

cachePage

public static void cachePage(String identifier,
                             PageLoader loader)

Puts the page into the page cache.

If the cache already inherits that identifier, it's renewed.

Parameters:

identifier - The identifier of the page

loader - The PageLoader (How it should load the page)

isCached

public static boolean isCached(String identifier)

Checks if the page is cached.

Parameters:

identifier - The identifier of the page

Returns:

true if the page is cached

removeIf

public static void removeIf(Predicate<String> filter)

Removes all of the elements of this cache that satisfy the given predicate.

Parameters:

filter - a predicate which returns true for entries to be removed

clearCache

public static void clearCache()

Clears the cache from all its contents.