io.siddhi.doc.gen.extensions

Class ExtensionDocCache

java.lang.Object

io.siddhi.doc.gen.extensions.ExtensionDocCache

public class ExtensionDocCache
extends Object

The ExtensionDocCache class works as the main manipulator of underline API response cache.

Constructor Summary

Constructors

Constructor and Description
ExtensionDocCache(Path cachePath) Constructs a ExtensionDocCache instance.

Method Summary

Modifier and Type	Method and Description
void	add(String extension, String description, String lastModifiedDateTime) The add method adds an extension with description and last modified date to the cache.
boolean	commit() The commit method writes the data to the given location in the local storage.
Map<String,String>	getExtensionDescriptionMap() The getExtensionDescriptionMap method returns a map of extensions with extension name as key and extension description as value.
String	getLastModifiedDateTime(String extension) The getLastModifiedDateTime returns the last modified date a given extension.
boolean	has(String extension) Return whether extension exists in the cache.
boolean	isInMemory()
void	remove(String extension) Remove an extension from the cache.
void	removeComplementOf(Set<String> extensions) Remove relative complement of the given extension set from the extension set in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionDocCache

public ExtensionDocCache(Path cachePath)

Constructs a ExtensionDocCache instance. Any failure occurs while reading the cache from local storage will cause constructor to create an in-memory cache.

Parameters:

cachePath - the path to the cache

Method Detail

has

public boolean has(String extension)

Return whether extension exists in the cache.

Parameters:

extension - the name of the cache

Returns:

whether extension exists in the cache

add

public void add(String extension,
                String description,
                String lastModifiedDateTime)

The add method adds an extension with description and last modified date to the cache.

Parameters:

extension - the name of the extension

description - the description for the extension

lastModifiedDateTime - the last modified date of the extension doc

getLastModifiedDateTime

public String getLastModifiedDateTime(String extension)

The getLastModifiedDateTime returns the last modified date a given extension.

Parameters:

extension - the name of the extension

Returns:

the the last modified date a given extension

remove

public void remove(String extension)

Remove an extension from the cache.

Parameters:

extension - the name of the extension

removeComplementOf

public void removeComplementOf(Set<String> extensions)

Remove relative complement of the given extension set from the extension set in the cache.

Parameters:

extensions - the extension set

isInMemory

public boolean isInMemory()

Returns:

whether cache is in-memory

commit

public boolean commit()

The commit method writes the data to the given location in the local storage. 1). If there is no update done to the cache it will return the false. 3). Due to any IO error if writing fails it will return the false. Overall method only returns true if it has written to the local storage.

Returns:

whether changes has made to the underline local storage

getExtensionDescriptionMap

public Map<String,String> getExtensionDescriptionMap()

The getExtensionDescriptionMap method returns a map of extensions with extension name as key and extension description as value.

Returns:

a map of extensions with extension name as key and extension description as value.