org.opencms.ade.configuration.formatters

类 CmsFormatterChangeSet

java.lang.Object

org.opencms.ade.configuration.formatters.CmsFormatterChangeSet

public class CmsFormatterChangeSet
extends java.lang.Object

This class represents the changes which can be made to formatters in a sitemap configuration file.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	PREFIX_TYPE The prefix used for types in the Add/RemoveFormatter fields in the configuration.

构造器概要

构造器

构造器和说明
CmsFormatterChangeSet()

方法概要

方法

限定符和类型	方法和说明
void	applyToFormatters(java.util.Map<CmsUUID,I_CmsFormatterBean> formatters, CmsFormatterConfigurationCacheState externalFormatters) Applies this change set to a list of external (non schema-based) formatters.
void	applyToTypes(java.util.Set<java.lang.String> types) Applies the changes (addition or removal of schema formatters) to a set of resource type names, adding resource types for which schema formatters should be added and removing those for which schema formatters should be removed.
void	initialize(java.util.Collection<java.lang.String> toRemove, java.util.Collection<java.lang.String> toAdd) Initializes this formatter change set with the values from the sitemap configuration.
static java.lang.String	keyForType(java.lang.String typeName) Produces the key for a given resource type.

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

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

字段详细资料

PREFIX_TYPE

public static final java.lang.String PREFIX_TYPE

The prefix used for types in the Add/RemoveFormatter fields in the configuration.

另请参阅:

常量字段值

构造器详细资料

CmsFormatterChangeSet

public CmsFormatterChangeSet()

方法详细资料

keyForType

public static java.lang.String keyForType(java.lang.String typeName)

Produces the key for a given resource type.

参数:

typeName - the resource type name

返回:

the key to use

applyToFormatters

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

Applies this change set to a list of external (non schema-based) formatters.

参数:

formatters - the map of formatters to which the changes should be applied

externalFormatters - the formatter collection which should be used to add formatters which are not already present in 'formatters'

applyToTypes

public void applyToTypes(java.util.Set<java.lang.String> types)

Applies the changes (addition or removal of schema formatters) to a set of resource type names, adding resource types for which schema formatters should be added and removing those for which schema formatters should be removed.

参数:

types - the set of types to apply the changes to

initialize

public void initialize(java.util.Collection<java.lang.String> toRemove,
              java.util.Collection<java.lang.String> toAdd)

Initializes this formatter change set with the values from the sitemap configuration.

参数:

toRemove - the keys for the formatters to remove

toAdd - the keys for the formatters to add