org.broadleafcommerce.common.persistence

Class AbstractEntityDuplicationHelper<T>

java.lang.Object

org.broadleafcommerce.common.persistence.AbstractEntityDuplicationHelper<T>

All Implemented Interfaces:

EntityDuplicationHelper<T>

Direct Known Subclasses:

OfferDuplicateModifier

public abstract class AbstractEntityDuplicationHelper<T>
extends Object
implements EntityDuplicationHelper<T>

Implements getCopyHints() and addCopyHint(String, String), using a HashMap as the underlying data structure for storing the hints. Also provides a helper method getCopySuffix() for the usual use-case of changing the name of the duplicated entity.

Author:

Nathan Moore (nathanmoore).

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	copyHints
protected org.springframework.core.env.Environment	env

Constructor Summary

Constructors

Constructor and Description
AbstractEntityDuplicationHelper(org.springframework.core.env.Environment environment)

Method Summary

Modifier and Type	Method and Description
void	addCopyHint(String name, String hint)
abstract boolean	canHandle(MultiTenantCloneable candidate)
Map<String,String>	getCopyHints()
protected String	getCopySuffix() Defaults to " - Copy" but can be overridden using admin.entity.duplication.suffix.default.
abstract void	modifyInitialDuplicateState(T copy)

Methods inherited from class java.lang.Object

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

Field Detail

copyHints

protected Map<String,String> copyHints

env

protected final org.springframework.core.env.Environment env

Constructor Detail

AbstractEntityDuplicationHelper

public AbstractEntityDuplicationHelper(org.springframework.core.env.Environment environment)

Method Detail

getCopySuffix

protected String getCopySuffix()

Defaults to " - Copy" but can be overridden using admin.entity.duplication.suffix.default.

Returns:

suffix to append to the name/identifier of the entity copy

canHandle

public abstract boolean canHandle(MultiTenantCloneable candidate)

Specified by:

canHandle in interface EntityDuplicationHelper<T>

getCopyHints

public Map<String,String> getCopyHints()

Specified by:

getCopyHints in interface EntityDuplicationHelper<T>

Returns:

Hints used to fine tune copying - generally support for hints is included in MultiTenantCloneable.createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext) implementations.

addCopyHint

public void addCopyHint(String name,
                        String hint)

Specified by:

addCopyHint in interface EntityDuplicationHelper<T>

modifyInitialDuplicateState

public abstract void modifyInitialDuplicateState(T copy)

Specified by:

modifyInitialDuplicateState in interface EntityDuplicationHelper<T>