AbstractCacheUnit (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.cache.AbstractCacheUnit

All Implemented Interfaces:

CacheValueLoader

Direct Known Subclasses:

AbstractRegioncacheRegistrableUnit, AnonymousCacheUnit, CustomCacheUnit, CustomCacheUnit, DefaultSLDDataContainerProvider.SLDItemBulkLoadUnit, DefaultSLDDataContainerProvider.SLDItemLoadUnit, FinderResult, GenericBMPBean.GenericItemEntityStateCacheUnit, IsItemAliveCheckUnit, JaloItemCacheUnit, JaloTypeCacheUnit, LuceneIndex.ResultBitSetCacheUnit, SLDPermissionManagementStrategy.AclCacheUnit
```
public abstract class AbstractCacheUnit
extends Object
implements CacheValueLoader
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected CacheKey`	`cacheKey`
`static int`	`INVALIDATIONTYPE_CREATED`
`static int`	`INVALIDATIONTYPE_MODIFIED`
`static String`	`INVALIDATIONTYPE_MODIFIED_STRING`
`static int`	`INVALIDATIONTYPE_REMOVED`
`static String`	`INVALIDATIONTYPE_REMOVED_STRING`
`static Object`	`UNKNOWN`

Constructor Summary

Constructors
Constructor and Description
`AbstractCacheUnit(Cache cache)`
`AbstractCacheUnit(Cache cache, String tenantId)` For testing
`AbstractCacheUnit(Cache cache, Tenant tenant)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addedToCacheBeforeComputation()`
`static boolean`	`arrayDeepEqualsReverse(Object[] objectArray1, Object[] objectArray2)` Deprecated. since 5.0.1
`abstract Object`	`compute()`
`abstract Object[]`	`createKey()`
`boolean`	`equals(Object object)`
`void`	`executeInvalidation()`
`Object`	`get()`
`protected Cache`	`getCache()`
`int`	`getInvalidationTopicDepth()` Returns the number of elements of the key that are elements of the invalidation topic key.
`CacheKey`	`getKey()`
`Object[]`	`getKeyAsArray()`
`CacheValueLoader<? extends AbstractCacheUnit>`	`getLoader()`
`String`	`getTenantID()`
`Object`	`getWithoutCompute()`
`Object`	`getWithoutComputeIgnoringTransaction()`
`int`	`hashCode()`
`protected void`	`hintValue(Object newValue)` This method allows direct setting of the value (without execution of `compute()`); it can be used if the value is available as result of some other operation; callers guarantee that the given value is equal to the Object that would be returned by a call to compute The new value will only be set if the object is not already in the cache.
`void`	`invalidate(int invalidationType)` mark the Cache Unit to be invalidated upon commit invalidationType is one of the constants (modified or remove)
`boolean`	`isCachingSupported()`
`boolean`	`isValueKnown()`
`boolean`	`isZombie()` Deprecated. since 5.0
`boolean`	`keepAlive()` Deprecated. since 5.0
`Object`	`load(CacheKey key)` We do not perform compute not to hit database several times from different threads. Another reason is to keep lifecycle of hooks in the same order.
`void`	`markKeptAlive()` Deprecated. since 5.0
`void`	`removedFromCache()`
`String`	`toString()`
`protected boolean`	`useCache()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - INVALIDATIONTYPE_MODIFIED
```
public static final int INVALIDATIONTYPE_MODIFIED
```
    See Also:
    
    Constant Field Values
  - INVALIDATIONTYPE_REMOVED
```
public static final int INVALIDATIONTYPE_REMOVED
```
    See Also:
    
    Constant Field Values
  - INVALIDATIONTYPE_CREATED
```
public static final int INVALIDATIONTYPE_CREATED
```
    See Also:
    
    Constant Field Values
  - INVALIDATIONTYPE_MODIFIED_STRING
```
public static final String INVALIDATIONTYPE_MODIFIED_STRING
```
  - INVALIDATIONTYPE_REMOVED_STRING
```
public static final String INVALIDATIONTYPE_REMOVED_STRING
```
  - UNKNOWN
```
public static Object UNKNOWN
```
  - cacheKey
```
protected volatile CacheKey cacheKey
```
- Constructor Detail
  - AbstractCacheUnit
```
public AbstractCacheUnit(Cache cache,
                         Tenant tenant)
```
  - AbstractCacheUnit
```
public AbstractCacheUnit(Cache cache,
                         String tenantId)
```
    For testing
  - AbstractCacheUnit
```
public AbstractCacheUnit(Cache cache)
```
- Method Detail
  - createKey
```
public abstract Object[] createKey()
```
  - getKey
```
public CacheKey getKey()
```
  - getLoader
```
public CacheValueLoader<? extends AbstractCacheUnit> getLoader()
```
  - load
```
public Object load(CacheKey key)
            throws CacheValueLoadException
```
    We do not perform compute not to hit database several times from different threads.
    Another reason is to keep lifecycle of hooks in the same order. addedToCacheBeforeComputation() is called here other callbacks in the RegionCacheAdapter.
    
    Specified by:
    
    load in interface CacheValueLoader
    
    Throws:
    
    CacheValueLoadException
  - compute
```
public abstract Object compute()
                        throws Exception
```
    Throws:
    
    Exception
  - getCache
```
protected Cache getCache()
```
  - isValueKnown
```
public boolean isValueKnown()
```
  - isCachingSupported
```
public boolean isCachingSupported()
```
  - getTenantID
```
public String getTenantID()
```
  - getKeyAsArray
```
public final Object[] getKeyAsArray()
```
  - useCache
```
protected boolean useCache()
```
  - get
```
public final Object get()
                 throws Exception
```
    Throws:
    
    Exception
  - getWithoutCompute
```
public Object getWithoutCompute()
```
  - getWithoutComputeIgnoringTransaction
```
public Object getWithoutComputeIgnoringTransaction()
```
  - getInvalidationTopicDepth
```
public int getInvalidationTopicDepth()
```
    Returns the number of elements of the key that are elements of the invalidation topic key. This method must be implemented for all AbstractCacheUnits that are invalidated externally.
  - hintValue
```
protected void hintValue(Object newValue)
```
    This method allows direct setting of the value (without execution of compute()); it can be used if the value is available as result of some other operation; callers guarantee that the given value is equal to the Object that would be returned by a call to compute The new value will only be set if the object is not already in the cache.
  - invalidate
```
public void invalidate(int invalidationType)
```
    mark the Cache Unit to be invalidated upon commit invalidationType is one of the constants (modified or remove)
  - keepAlive
```
@Deprecated
public boolean keepAlive()
```
    Deprecated. since 5.0
    
    Override this to make a cache unit stay in cache even if it'd be removed due to invalidation. This is called only upon invalidation attempt. This does not affect normal removal due to cache being limited. Since 5.0 cache key unit it self can extend its life span until generation matches.
    
    Returns:
    
    true if the unit should stay inside cache
  - isZombie
```
@Deprecated
public boolean isZombie()
```
    Deprecated. since 5.0
  - markKeptAlive
```
@Deprecated
public void markKeptAlive()
```
    Deprecated. since 5.0
  - removedFromCache
```
public void removedFromCache()
```
  - addedToCacheBeforeComputation
```
public void addedToCacheBeforeComputation()
```
  - executeInvalidation
```
public void executeInvalidation()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - arrayDeepEqualsReverse
```
@Deprecated
public static boolean arrayDeepEqualsReverse(Object[] objectArray1,
                                                         Object[] objectArray2)
```
    Deprecated. since 5.0.1

Class AbstractCacheUnit

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALIDATIONTYPE_MODIFIED

INVALIDATIONTYPE_REMOVED

INVALIDATIONTYPE_CREATED

INVALIDATIONTYPE_MODIFIED_STRING

INVALIDATIONTYPE_REMOVED_STRING

UNKNOWN

cacheKey

Constructor Detail

AbstractCacheUnit

AbstractCacheUnit

AbstractCacheUnit

Method Detail

createKey

getKey

getLoader

load

compute

getCache

isValueKnown

isCachingSupported

getTenantID

getKeyAsArray

useCache

get

getWithoutCompute

getWithoutComputeIgnoringTransaction

getInvalidationTopicDepth

hintValue

invalidate

keepAlive

isZombie

markKeptAlive

removedFromCache

addedToCacheBeforeComputation

executeInvalidation

hashCode

equals

toString

arrayDeepEqualsReverse