Package de.hybris.platform.cms2.cloning.service.impl

Class CMSModelCloningContext

java.lang.Object

de.hybris.platform.cms2.cloning.service.impl.CMSModelCloningContext

All Implemented Interfaces:

ModelCloningContext

public class CMSModelCloningContext
extends java.lang.Object
implements ModelCloningContext

Defines the ModelCloningContext to use for deep cloning components that are supported by SmartEdit. The cloning context specifies if a given attribute should be treated as partOf, should be skipped or should use a preset value.

Constructor Summary

Constructors

Constructor	Description
CMSModelCloningContext()

Method Summary

Modifier and Type	Method	Description
void	addPresetValuePredicate(AttributePresetHandler presetValueHandler)	Allows to add AttributePresetHandler directly to the list of presetValueHandlers.
java.lang.Object	getPresetValue(java.lang.Object component, java.lang.String qualifier)	Only valid if ModelCloningContext.usePresetValue(Object, String) returns true for the specified attribute.
protected java.util.List<AttributePresetHandler<java.lang.Object>>	getPresetValueHandlers()
protected java.util.List<java.util.function.BiPredicate<ItemModel,java.lang.String>>	getPresetValuePredicates()	Deprecated, for removal: This API element is subject to removal in a future version. since 2105, please use getPresetValueHandlers() instead.
protected java.util.List<java.util.function.BiPredicate<ItemModel,java.lang.String>>	getTreatAsPartOfPredicates()
void	setPresetValueHandlers(java.util.List<AttributePresetHandler<java.lang.Object>> presetValueHandlers)
void	setPresetValuePredicates(java.util.List<java.util.function.BiPredicate<ItemModel,java.lang.String>> presetValuePredicates)	Deprecated, for removal: This API element is subject to removal in a future version. since 2105, please use getPresetValueHandlers() instead.
void	setTreatAsPartOfPredicates(java.util.List<java.util.function.BiPredicate<ItemModel,java.lang.String>> treatAsPartOfPredicates)
boolean	skipAttribute(java.lang.Object component, java.lang.String qualifier)	If true that particular attribute will not be included in the cloning process.
boolean	treatAsPartOf(java.lang.Object component, java.lang.String qualifier)	If true that particular attribute is treated as partOf which results in deep-cloning each attribute value too before assigning them as value to the cloned model.
boolean	usePresetValue(java.lang.Object component, java.lang.String qualifier)	If true for the given attribute the cloning process will not use the original model attribute values but the one returned by ModelCloningContext.getPresetValue(Object, String).

Methods inherited from class java.lang.Object

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

Constructor Detail

CMSModelCloningContext

public CMSModelCloningContext()

Method Detail

treatAsPartOf

public boolean treatAsPartOf(java.lang.Object component,
                             java.lang.String qualifier)

Description copied from interface: ModelCloningContext

If true that particular attribute is treated as partOf which results in deep-cloning each attribute value too before assigning them as value to the cloned model.

This applies to model reference attributes only!

Specified by:

treatAsPartOf in interface ModelCloningContext

skipAttribute

public boolean skipAttribute(java.lang.Object component,
                             java.lang.String qualifier)

Description copied from interface: ModelCloningContext

If true that particular attribute will not be included in the cloning process. As a result the cloned model will not have any value for that attribute.

Specified by:

skipAttribute in interface ModelCloningContext

usePresetValue

public boolean usePresetValue(java.lang.Object component,
                              java.lang.String qualifier)

Description copied from interface: ModelCloningContext

If true for the given attribute the cloning process will not use the original model attribute values but the one returned by ModelCloningContext.getPresetValue(Object, String).

Specified by:

usePresetValue in interface ModelCloningContext

See Also:

ModelCloningContext.getPresetValue(Object, String)

getPresetValue

public java.lang.Object getPresetValue(java.lang.Object component,
                                       java.lang.String qualifier)

Description copied from interface: ModelCloningContext

Only valid if ModelCloningContext.usePresetValue(Object, String) returns true for the specified attribute.

Returns the value to be used as attribute value of the new cloned model.

Specified by:

getPresetValue in interface ModelCloningContext

addPresetValuePredicate

public void addPresetValuePredicate(AttributePresetHandler presetValueHandler)

Allows to add AttributePresetHandler directly to the list of presetValueHandlers.

Parameters:

presetValueHandler - the new AttributePresetHandler handler.

getTreatAsPartOfPredicates

protected java.util.List<java.util.function.BiPredicate<ItemModel,java.lang.String>> getTreatAsPartOfPredicates()

setTreatAsPartOfPredicates

public void setTreatAsPartOfPredicates(java.util.List<java.util.function.BiPredicate<ItemModel,java.lang.String>> treatAsPartOfPredicates)

getPresetValuePredicates

@Deprecated(since="2105",
            forRemoval=true)
protected java.util.List<java.util.function.BiPredicate<ItemModel,java.lang.String>> getPresetValuePredicates()

Deprecated, for removal: This API element is subject to removal in a future version.

since 2105, please use getPresetValueHandlers() instead.

setPresetValuePredicates

@Deprecated(since="2105",
            forRemoval=true)
public void setPresetValuePredicates(java.util.List<java.util.function.BiPredicate<ItemModel,java.lang.String>> presetValuePredicates)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2105, please use getPresetValueHandlers() instead.

getPresetValueHandlers

protected java.util.List<AttributePresetHandler<java.lang.Object>> getPresetValueHandlers()

setPresetValueHandlers

public void setPresetValueHandlers(java.util.List<AttributePresetHandler<java.lang.Object>> presetValueHandlers)