org.opencms.ade.configuration.formatters

类 CmsFormatterConfigurationCacheState

java.lang.Object

org.opencms.ade.configuration.formatters.CmsFormatterConfigurationCacheState

public class CmsFormatterConfigurationCacheState
extends java.lang.Object

Represents the currently cached collection of all formatter beans extracted from formatter configuration files.

Objects of this class are immutable, but have a method to create an updated copy.

构造器概要

构造器

构造器和说明
CmsFormatterConfigurationCacheState(java.util.Map<CmsUUID,I_CmsFormatterBean> formatters) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
CmsFormatterConfigurationCacheState	createUpdatedCopy(java.util.Map<CmsUUID,I_CmsFormatterBean> updateFormatters) Creates a new copy of this state in which some entries are removed or replaced.
java.util.Map<CmsUUID,I_CmsFormatterBean>	getAutoEnabledFormatters() Gets the map of formatters which are automatically enabled.
java.util.Map<CmsUUID,I_CmsFormatterBean>	getFormatters() Gets the map of all formatters.
java.util.Collection<I_CmsFormatterBean>	getFormattersForType(java.lang.String resourceType, boolean filterAutoEnabled) Gets the formatters for a specific resource types, and optionally only returns those which are automatically enabled.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsFormatterConfigurationCacheState

public CmsFormatterConfigurationCacheState(java.util.Map<CmsUUID,I_CmsFormatterBean> formatters)

Creates a new instance.

参数:

formatters - the initial map of formatters

方法详细资料

createUpdatedCopy

public CmsFormatterConfigurationCacheState createUpdatedCopy(java.util.Map<CmsUUID,I_CmsFormatterBean> updateFormatters)

Creates a new copy of this state in which some entries are removed or replaced.

This does not change the state object on which the method is called.

参数:

updateFormatters - a map of formatters to change, where the key is the structure id and the value is either the replacement or null if the map entry should be removed

返回:

the updated copy

getAutoEnabledFormatters

public java.util.Map<CmsUUID,I_CmsFormatterBean> getAutoEnabledFormatters()

Gets the map of formatters which are automatically enabled.

返回:

the map of automatically enabled formatters with structure ids as keys

getFormatters

public java.util.Map<CmsUUID,I_CmsFormatterBean> getFormatters()

Gets the map of all formatters.

返回:

the map of all formatters

getFormattersForType

public java.util.Collection<I_CmsFormatterBean> getFormattersForType(java.lang.String resourceType,
                                                            boolean filterAutoEnabled)

Gets the formatters for a specific resource types, and optionally only returns those which are automatically enabled.

参数:

resourceType - the resource type name

filterAutoEnabled - true if only the automatically enabled formatters should be returned

返回:

the formatters for the type