CockpitZulCache (cockpitng 20.05.0-RC3 API)

All Superinterfaces:

Resettable

All Known Implementing Classes:

DefaultCockpitZulCache
```
public interface CockpitZulCache
extends Resettable
```
Cache for PageDefinitions. Used by CockpitUIFactory to cache e.g. widget view definitions.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`org.zkoss.zk.ui.metainfo.PageDefinition`	`addPageDefinitionToCache(java.lang.String path, org.zkoss.zk.ui.metainfo.PageDefinition def)`	Adds a `PageDefinition` to the cache.
`java.util.Set<java.lang.String>`	`getDefinitionPaths()`	Returns all paths currently stored in the cache.
`org.zkoss.zk.ui.metainfo.PageDefinition`	`getPageDefinition(java.lang.String path)`	Returns the `PageDefinition` for a given path.
`void`	`reset()`	Clears all entries in the cache.

- Method Detail
  - getPageDefinition
```
org.zkoss.zk.ui.metainfo.PageDefinition getPageDefinition(java.lang.String path)
```
    Returns the PageDefinition for a given path.
    
    Parameters:
    
    path - An unique identifier for the page.
    
    Returns:
    
    A PageDefinition, if present in the cache, or null otherwise.
  - addPageDefinitionToCache
```
org.zkoss.zk.ui.metainfo.PageDefinition addPageDefinitionToCache(java.lang.String path,
                                                                 org.zkoss.zk.ui.metainfo.PageDefinition def)
```
    Adds a PageDefinition to the cache.
    
    Parameters:
    
    path - The path to the zul file.
    
    def - The PageDefinition to add to the cache.
    
    Returns:
    
    The PageDefinition that was added (for convenience).
  - getDefinitionPaths
```
java.util.Set<java.lang.String> getDefinitionPaths()
```
    Returns all paths currently stored in the cache.
  - reset
```
void reset()
```
    Clears all entries in the cache.
    
    Specified by:
    
    reset in interface Resettable