Package de.hybris.platform.regioncache.key

Class AbstractCacheKey

java.lang.Object

de.hybris.platform.regioncache.key.AbstractCacheKey

All Implemented Interfaces:

CacheKey

Direct Known Subclasses:

AbstractRegistrableCacheKey, CsrfParametersCacheKey, DefaultDeletedItemCacheKey, LegacyCacheKey, ObjectCacheKey, ProductConfigurationCacheKey, ProductConfigurationEHCacheAccessImplTest.StringCacheKey, TestCacheKey, WebhookDeletedItemCacheKey

public abstract class AbstractCacheKey
extends Object
implements CacheKey

Abstract class used as a base class for regioncache keys.
CacheKey can mark associated value as serializable or nor (CacheUnitType).
CacheKey carries information of type code (String).

Known subtypes:

• LegacyCacheKey: used to convert between Object[] and CacheKey
• RegistrableCacheKey: used to mark a cache unit as using cache registry

Field Summary

Fields

Modifier and Type	Field	Description
protected int	cachedHash
protected final String	tenantId
protected final Object	typeCode	Each key has value and type.
protected final CacheUnitValueType	valueType	Defines if associated value is SERIALIZABLE or NON_SERIALIZABLE.

Constructor Summary

Constructors

Constructor	Description
AbstractCacheKey(CacheUnitValueType valueType, Object typeCode, String tenantId)	Creates key for supplied type and value type.
AbstractCacheKey(Object typeCode, String tenantId)	Creates NON_SERIALIZABLE key for supplied type.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
CacheUnitValueType	getCacheValueType()	gets value type.
String	getTenantId()	Gets tenant
Object	getTypeCode()	Gets code from typesystem.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

valueType

protected final CacheUnitValueType valueType

Defines if associated value is SERIALIZABLE or NON_SERIALIZABLE.
By the default values are considered NON_SERIALIZABLE. This should change in hybris 5.

tenantId

protected final String tenantId

cachedHash

protected int cachedHash

typeCode

protected final Object typeCode

Each key has value and type. This field keeps type.

Constructor Details

AbstractCacheKey

public AbstractCacheKey(Object typeCode,
 String tenantId)

Creates NON_SERIALIZABLE key for supplied type.

AbstractCacheKey

public AbstractCacheKey(CacheUnitValueType valueType,
 Object typeCode,
 String tenantId)

Creates key for supplied type and value type.

Method Details

getCacheValueType

public CacheUnitValueType getCacheValueType()

gets value type. Currently not used. To be used in hybris 5.

Specified by:

getCacheValueType in interface CacheKey

getTypeCode

public Object getTypeCode()

Gets code from typesystem.

Specified by:

getTypeCode in interface CacheKey

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTenantId

public String getTenantId()

Description copied from interface: CacheKey

Gets tenant

Specified by:

getTenantId in interface CacheKey

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object