CmsXmlSitemapCache (OpenCms Core API, version 17.0)

java.lang.Object
- org.opencms.site.xmlsitemap.CmsXmlSitemapCache

public class CmsXmlSitemapCache
extends java.lang.Object

Cache for XML sitemaps.

Field Summary

Fields
Modifier and Type Field Description

static CmsXmlSitemapCache INSTANCE
Static instance for this class.

Constructor Summary

Constructors
Constructor Description

CmsXmlSitemapCache()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`	Clears the cache.
`java.lang.String`	`get(java.lang.String key)`	Gets the cached entry for the given key (the key will normally be the root path of a sitemap.xml file).
`void`	`put(java.lang.String key, java.lang.String value)`	Stores an XML sitemap in the cache.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final CmsXmlSitemapCache INSTANCE
```
    Static instance for this class.
- Constructor Detail
  - CmsXmlSitemapCache
```
public CmsXmlSitemapCache()
```
- Method Detail
  - clear
```
public void clear()
```
    Clears the cache.
  - get
```
public java.lang.String get(java.lang.String key)
```
    Gets the cached entry for the given key (the key will normally be the root path of a sitemap.xml file).
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the cached XML sitemap, or null if no cached value exists
  - put
```
public void put(java.lang.String key,
                java.lang.String value)
```
    Stores an XML sitemap in the cache.
    
    Parameters:
    
    key - the XML sitemap key (usually the root path of the sitemap.xml)
    
    value - the XML sitemap content