Package com.tangosol.coherence.jcache

Class AbstractCoherenceBasedCompleteConfiguration<K,V>

java.lang.Object
com.tangosol.coherence.jcache.AbstractCoherenceBasedCompleteConfiguration<K,V>
Type Parameters:
K - the type of the keys
V - the type of the values
All Implemented Interfaces:
CoherenceBasedCompleteConfiguration<K,V>, CoherenceBasedConfiguration<K,V>, ExternalizableLite, PortableObject, Serializable, javax.cache.configuration.CompleteConfiguration<K,V>, javax.cache.configuration.Configuration<K,V>
Direct Known Subclasses:
LocalCacheConfiguration, PartitionedCacheConfiguration, RemoteCacheConfiguration
public abstract class AbstractCoherenceBasedCompleteConfiguration<K,V> extends Object implements CoherenceBasedCompleteConfiguration<K,V>, ExternalizableLite, PortableObject
A base implementation of a CoherenceBasedCompleteConfiguration.
Since:
Coherence 12.1.3
Author:
bo 2013.11.12
See Also:

  • Field Details

    • m_clzKey

      protected Class<K> m_clzKey
      The type of keys for Caches.

    • m_clzValue

      protected Class<V> m_clzValue
      The type of values for Caches.

    • m_listListenerConfigurations

      protected List<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>> m_listListenerConfigurations
      The CacheEntryListenerConfigurations.

    • m_factoryCacheLoader

      protected javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>> m_factoryCacheLoader
      The Factory for the CacheLoader.

    • m_factoryCacheWriter

      protected javax.cache.configuration.Factory<javax.cache.integration.CacheWriter<? super K,? super V>> m_factoryCacheWriter
      The Factory for the CacheWriter.

    • m_factoryExpiryPolicy

      protected javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> m_factoryExpiryPolicy
      The Factory for the ExpiryPolicy.

    • m_fReadThrough

      protected boolean m_fReadThrough
      Is "read-through" enabled?

    • m_fWriteThrough

      protected boolean m_fWriteThrough
      Is "write-through" enabled?

    • m_fStatisticsEnabled

      protected boolean m_fStatisticsEnabled
      Are statistics enabled?

    • m_fStoreByValue

      protected boolean m_fStoreByValue
      Is store-by-reference enabled?

    • m_fManagementEnabled

      protected boolean m_fManagementEnabled
      Is JMX management enabled?

  • Constructor Details

    • AbstractCoherenceBasedCompleteConfiguration

      public AbstractCoherenceBasedCompleteConfiguration()
      Constructs an AbstractCoherenceBasedCompleteConfiguration.

    • AbstractCoherenceBasedCompleteConfiguration

      public AbstractCoherenceBasedCompleteConfiguration(javax.cache.configuration.CompleteConfiguration<K,V> cfgComplete)
      Constructs an AbstractCoherenceBasedCompleteConfiguration based on another CompleteConfiguration.
      Parameters:
      cfgComplete - the CompleteConfiguration

  • Method Details

    • getKeyType

      public Class<K> getKeyType()
      Specified by:
      getKeyType in interface javax.cache.configuration.Configuration<K,V>

    • getValueType

      public Class<V> getValueType()
      Specified by:
      getValueType in interface javax.cache.configuration.Configuration<K,V>

    • isStoreByValue

      public boolean isStoreByValue()
      Specified by:
      isStoreByValue in interface javax.cache.configuration.Configuration<K,V>

    • getCacheEntryListenerConfigurations

      public List<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>> getCacheEntryListenerConfigurations()
      Specified by:
      getCacheEntryListenerConfigurations in interface javax.cache.configuration.CompleteConfiguration<K,V>

    • getCacheLoaderFactory

      public javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>> getCacheLoaderFactory()
      Specified by:
      getCacheLoaderFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>

    • getCacheWriterFactory

      public javax.cache.configuration.Factory<javax.cache.integration.CacheWriter<? super K,? super V>> getCacheWriterFactory()
      Specified by:
      getCacheWriterFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>

    • getExpiryPolicyFactory

      public javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> getExpiryPolicyFactory()
      Specified by:
      getExpiryPolicyFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>

    • isReadThrough

      public boolean isReadThrough()
      Specified by:
      isReadThrough in interface javax.cache.configuration.CompleteConfiguration<K,V>

    • isWriteThrough

      public boolean isWriteThrough()
      Specified by:
      isWriteThrough in interface javax.cache.configuration.CompleteConfiguration<K,V>

    • isStatisticsEnabled

      public boolean isStatisticsEnabled()
      Specified by:
      isStatisticsEnabled in interface javax.cache.configuration.CompleteConfiguration<K,V>

    • isManagementEnabled

      public boolean isManagementEnabled()
      Specified by:
      isManagementEnabled in interface javax.cache.configuration.CompleteConfiguration<K,V>

    • setTypes

      public void setTypes(Class<K> clzKey, Class<V> clzValue)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Sets the expected type of keys and values for a CoherenceBasedCache.

      Setting both to Object.class means type-safety checks are not required.

      Specified by:
      setTypes in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      clzKey - the expected key type
      clzValue - the expected value type

    • addCacheEntryListenerConfiguration

      public void addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cfgListener)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Add a configuration for a CacheEntryListener.
      Specified by:
      addCacheEntryListenerConfiguration in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      cfgListener - the CacheEntryListenerConfiguration

    • setCacheLoaderFactory

      public void setCacheLoaderFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheLoader<K,V>> factory)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Set the CacheLoader factory.
      Specified by:
      setCacheLoaderFactory in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      factory - the CacheLoader Factory

    • setCacheWriterFactory

      public void setCacheWriterFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K,? super V>> factory)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Set the CacheWriter factory.
      Specified by:
      setCacheWriterFactory in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      factory - the CacheWriter Factory

    • setExpiryPolicyFactory

      public void setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy> factory)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Set the Factory for the ExpiryPolicy.

      If null is specified the default ExpiryPolicy is used.

      Specified by:
      setExpiryPolicyFactory in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      factory - the ExpiryPolicy Factory

    • setReadThrough

      public void setReadThrough(boolean fReadThrough)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Set if read-through caching should be used.

      It is an invalid configuration to set this to true without specifying a CacheLoader Factory.

      Specified by:
      setReadThrough in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      fReadThrough - true if read-through is required

    • setWriteThrough

      public void setWriteThrough(boolean fWriteThrough)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Set if write-through caching should be used.

      It is an invalid configuration to set this to true without specifying a CacheWriter Factory.

      Specified by:
      setWriteThrough in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      fWriteThrough - true if write-through is required

    • setStoreByValue

      public void setStoreByValue(boolean fStoreByValue)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Set if a configured cache should use store-by-value or store-by-reference semantics.
      Specified by:
      setStoreByValue in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      fStoreByValue - true for store-by-value semantics, false for store-by-reference semantics

    • setStatisticsEnabled

      public void setStatisticsEnabled(boolean fStatisticsEnabled)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Set if statistics gathering is enabled for a configuration.

      Statistics may be enabled or disabled at runtime via CacheManager.enableStatistics(String, boolean).

      Specified by:
      setStatisticsEnabled in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      fStatisticsEnabled - true to enable statistics gathering, false to disable

    • setManagementEnabled

      public void setManagementEnabled(boolean fManagementEnabled)
      Description copied from interface: CoherenceBasedCompleteConfiguration
      Set if JMX management is enabled for a configuration.

      Management may be enabled or disabled at runtime via CacheManager.enableManagement(String, boolean).

      Specified by:
      setManagementEnabled in interface CoherenceBasedCompleteConfiguration<K,V>
      Parameters:
      fManagementEnabled - true to enable statistics, false to disable

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • readExternal

      public void readExternal(DataInput in) throws IOException
      Description copied from interface: ExternalizableLite
      Restore the contents of this object by loading the object's state from the passed DataInput object.
      Specified by:
      readExternal in interface ExternalizableLite
      Parameters:
      in - the DataInput stream to read data from in order to restore the state of this object
      Throws:
      IOException - if an I/O exception occurs
      NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

    • writeExternal

      public void writeExternal(DataOutput out) throws IOException
      Description copied from interface: ExternalizableLite
      Save the contents of this object by storing the object's state into the passed DataOutput object.
      Specified by:
      writeExternal in interface ExternalizableLite
      Parameters:
      out - the DataOutput stream to write the state of this object to
      Throws:
      IOException - if an I/O exception occurs

    • readExternal

      public void readExternal(PofReader in) throws IOException
      Description copied from interface: PortableObject
      Restore the contents of a user type instance by reading its state using the specified PofReader object.
      Specified by:
      readExternal in interface PortableObject
      Parameters:
      in - the PofReader from which to read the object's state
      Throws:
      IOException - if an I/O error occurs

    • writeExternal

      public void writeExternal(PofWriter out) throws IOException
      Description copied from interface: PortableObject
      Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
      Specified by:
      writeExternal in interface PortableObject
      Parameters:
      out - the PofWriter to which to write the object's state
      Throws:
      IOException - if an I/O error occurs