Package org.opencms.configuration

Enum Class CmsImageCacheConfiguration.RetentionMode

java.lang.Object

java.lang.Enum<CmsImageCacheConfiguration.RetentionMode>

org.opencms.configuration.CmsImageCacheConfiguration.RetentionMode

All Implemented Interfaces:

Serializable, Comparable<CmsImageCacheConfiguration.RetentionMode>, Constable

Enclosing class:

CmsImageCacheConfiguration

public static enum CmsImageCacheConfiguration.RetentionMode
extends Enum<CmsImageCacheConfiguration.RetentionMode>

Retention modes.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
external	Cache retention is managed outside OpenCms.
fixed	Entries expire based on their creation or replacement timestamp.
renewOnUse	Entries are renewed when successfully used within the renewal window.

Method Summary

Modifier and Type	Method	Description
static CmsImageCacheConfiguration.RetentionMode	fromXmlValue(String value)	Parses a retention mode.
String	getXmlValue()	Returns the XML value.
static CmsImageCacheConfiguration.RetentionMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CmsImageCacheConfiguration.RetentionMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

external

public static final CmsImageCacheConfiguration.RetentionMode external

Cache retention is managed outside OpenCms.

fixed

public static final CmsImageCacheConfiguration.RetentionMode fixed

Entries expire based on their creation or replacement timestamp.

renewOnUse

public static final CmsImageCacheConfiguration.RetentionMode renewOnUse

Entries are renewed when successfully used within the renewal window.

Method Details

values

public static CmsImageCacheConfiguration.RetentionMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CmsImageCacheConfiguration.RetentionMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromXmlValue

public static CmsImageCacheConfiguration.RetentionMode fromXmlValue(String value)

Parses a retention mode.

Parameters:

value - the XML value

Returns:

the retention mode

getXmlValue

public String getXmlValue()

Returns the XML value.

Returns:

the XML value