LocalCache (config-api 0.3.12 API)

java.lang.Object
- org.wildfly.swarm.config.infinispan.cache_container.LocalCache<T>

public class LocalCache<T extends LocalCache>
extends Object

A local cache configuration

Constructor Summary

Constructors
Constructor and Description

LocalCache(String key)

Constructors
Constructor and Description
`LocalCache(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`activations()` The number of cache node activations (bringing a node into memory from a cache store) .
`T`	`activations(Long value)` The number of cache node activations (bringing a node into memory from a cache store) .
`Long`	`averageReadTime()` Average time (in ms) for cache reads.
`T`	`averageReadTime(Long value)` Average time (in ms) for cache reads.
`Long`	`averageWriteTime()` Average time (in ms) for cache writes.
`T`	`averageWriteTime(Long value)` Average time (in ms) for cache writes.
`BinaryJDBCStore`	`binaryJdbcStore()` The cache JDBC store configuration.
`T`	`binaryJdbcStore(BinaryJDBCStore value)` The cache JDBC store configuration.
`String`	`cacheStatus()` The status of the cache component.
`T`	`cacheStatus(String value)` The status of the cache component.
`CustomStore`	`customStore()` The cache store configuration.
`T`	`customStore(CustomStore value)` The cache store configuration.
`Long`	`elapsedTime()` Time (in secs) since cache started.
`T`	`elapsedTime(Long value)` Time (in secs) since cache started.
`EvictionComponent`	`evictionComponent()` The cache eviction configuration.
`T`	`evictionComponent(EvictionComponent value)` The cache eviction configuration.
`ExpirationComponent`	`expirationComponent()` The cache expiration configuration.
`T`	`expirationComponent(ExpirationComponent value)` The cache expiration configuration.
`FileStore`	`fileStore()` The cache file store configuration.
`T`	`fileStore(FileStore value)` The cache file store configuration.
`String`	`getKey()`
`Double`	`hitRatio()` The hit/miss ratio for the cache (hits/hits+misses).
`T`	`hitRatio(Double value)` The hit/miss ratio for the cache (hits/hits+misses).
`Long`	`hits()` The number of cache attribute hits.
`T`	`hits(Long value)` The number of cache attribute hits.
`Long`	`invalidations()` The number of cache invalidations.
`T`	`invalidations(Long value)` The number of cache invalidations.
`String`	`jndiName()` The jndi-name to which to bind this cache instance.
`T`	`jndiName(String value)` The jndi-name to which to bind this cache instance.
`LockingComponent`	`lockingComponent()` The locking configuration of the cache.
`T`	`lockingComponent(LockingComponent value)` The locking configuration of the cache.
`Long`	`misses()` The number of cache attribute misses.
`T`	`misses(Long value)` The number of cache attribute misses.
`MixedJDBCStore`	`mixedJdbcStore()` The cache JDBC store configuration.
`T`	`mixedJdbcStore(MixedJDBCStore value)` The cache JDBC store configuration.
`String`	`module()` The module whose class loader should be used when building this cache's configuration.
`T`	`module(String value)` The module whose class loader should be used when building this cache's configuration.
`NoneStore`	`noneStore()` A store-less configuration.
`T`	`noneStore(NoneStore value)` A store-less configuration.
`Integer`	`numberOfEntries()` The current number of entries in the cache.
`T`	`numberOfEntries(Integer value)` The current number of entries in the cache.
`Long`	`passivations()` The number of cache node passivations (passivating a node from memory to a cache store).
`T`	`passivations(Long value)` The number of cache node passivations (passivating a node from memory to a cache store).
`Double`	`readWriteRatio()` The read/write ratio of the cache ((hits+misses)/stores).
`T`	`readWriteRatio(Double value)` The read/write ratio of the cache ((hits+misses)/stores).
`RemoteStore`	`remoteStore()` The cache remote store configuration.
`T`	`remoteStore(RemoteStore value)` The cache remote store configuration.
`Long`	`removeHits()` The number of cache attribute remove hits.
`T`	`removeHits(Long value)` The number of cache attribute remove hits.
`Long`	`removeMisses()` The number of cache attribute remove misses.
`T`	`removeMisses(Long value)` The number of cache attribute remove misses.
`Boolean`	`statisticsEnabled()` If enabled, statistics will be collected for this cache
`T`	`statisticsEnabled(Boolean value)` If enabled, statistics will be collected for this cache
`Long`	`stores()` The number of cache attribute put operations.
`T`	`stores(Long value)` The number of cache attribute put operations.
`StringJDBCStore`	`stringJdbcStore()` The cache JDBC store configuration.
`T`	`stringJdbcStore(StringJDBCStore value)` The cache JDBC store configuration.
`Long`	`timeSinceReset()` Time (in secs) since cache statistics were reset.
`T`	`timeSinceReset(Long value)` Time (in secs) since cache statistics were reset.
`TransactionComponent`	`transactionComponent()` The cache transaction configuration.
`T`	`transactionComponent(TransactionComponent value)` The cache transaction configuration.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LocalCache
```
public LocalCache(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - activations
```
public Long activations()
```
    The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.
  - activations
```
public T activations(Long value)
```
    The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.
  - averageReadTime
```
public Long averageReadTime()
```
    Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.
  - averageReadTime
```
public T averageReadTime(Long value)
```
    Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.
  - averageWriteTime
```
public Long averageWriteTime()
```
    Average time (in ms) for cache writes. May return null if the cache is not started.
  - averageWriteTime
```
public T averageWriteTime(Long value)
```
    Average time (in ms) for cache writes. May return null if the cache is not started.
  - cacheStatus
```
public String cacheStatus()
```
    The status of the cache component. May return null if the cache is not started.
  - cacheStatus
```
public T cacheStatus(String value)
```
    The status of the cache component. May return null if the cache is not started.
  - elapsedTime
```
public Long elapsedTime()
```
    Time (in secs) since cache started. May return null if the cache is not started.
  - elapsedTime
```
public T elapsedTime(Long value)
```
    Time (in secs) since cache started. May return null if the cache is not started.
  - hitRatio
```
public Double hitRatio()
```
    The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.
  - hitRatio
```
public T hitRatio(Double value)
```
    The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.
  - hits
```
public Long hits()
```
    The number of cache attribute hits. May return null if the cache is not started.
  - hits
```
public T hits(Long value)
```
    The number of cache attribute hits. May return null if the cache is not started.
  - invalidations
```
public Long invalidations()
```
    The number of cache invalidations. May return null if the cache is not started.
  - invalidations
```
public T invalidations(Long value)
```
    The number of cache invalidations. May return null if the cache is not started.
  - jndiName
```
public String jndiName()
```
    The jndi-name to which to bind this cache instance.
  - jndiName
```
public T jndiName(String value)
```
    The jndi-name to which to bind this cache instance.
  - misses
```
public Long misses()
```
    The number of cache attribute misses. May return null if the cache is not started.
  - misses
```
public T misses(Long value)
```
    The number of cache attribute misses. May return null if the cache is not started.
  - module
```
public String module()
```
    The module whose class loader should be used when building this cache's configuration.
  - module
```
public T module(String value)
```
    The module whose class loader should be used when building this cache's configuration.
  - numberOfEntries
```
public Integer numberOfEntries()
```
    The current number of entries in the cache. May return null if the cache is not started.
  - numberOfEntries
```
public T numberOfEntries(Integer value)
```
    The current number of entries in the cache. May return null if the cache is not started.
  - passivations
```
public Long passivations()
```
    The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.
  - passivations
```
public T passivations(Long value)
```
    The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.
  - readWriteRatio
```
public Double readWriteRatio()
```
    The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.
  - readWriteRatio
```
public T readWriteRatio(Double value)
```
    The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.
  - removeHits
```
public Long removeHits()
```
    The number of cache attribute remove hits. May return null if the cache is not started.
  - removeHits
```
public T removeHits(Long value)
```
    The number of cache attribute remove hits. May return null if the cache is not started.
  - removeMisses
```
public Long removeMisses()
```
    The number of cache attribute remove misses. May return null if the cache is not started.
  - removeMisses
```
public T removeMisses(Long value)
```
    The number of cache attribute remove misses. May return null if the cache is not started.
  - statisticsEnabled
```
public Boolean statisticsEnabled()
```
    If enabled, statistics will be collected for this cache
  - statisticsEnabled
```
public T statisticsEnabled(Boolean value)
```
    If enabled, statistics will be collected for this cache
  - stores
```
public Long stores()
```
    The number of cache attribute put operations. May return null if the cache is not started.
  - stores
```
public T stores(Long value)
```
    The number of cache attribute put operations. May return null if the cache is not started.
  - timeSinceReset
```
public Long timeSinceReset()
```
    Time (in secs) since cache statistics were reset. May return null if the cache is not started.
  - timeSinceReset
```
public T timeSinceReset(Long value)
```
    Time (in secs) since cache statistics were reset. May return null if the cache is not started.
  - evictionComponent
```
public EvictionComponent evictionComponent()
```
    The cache eviction configuration.
  - evictionComponent
```
public T evictionComponent(EvictionComponent value)
```
    The cache eviction configuration.
  - stringJdbcStore
```
public StringJDBCStore stringJdbcStore()
```
    The cache JDBC store configuration.
  - stringJdbcStore
```
public T stringJdbcStore(StringJDBCStore value)
```
    The cache JDBC store configuration.
  - customStore
```
public CustomStore customStore()
```
    The cache store configuration.
  - customStore
```
public T customStore(CustomStore value)
```
    The cache store configuration.
  - expirationComponent
```
public ExpirationComponent expirationComponent()
```
    The cache expiration configuration.
  - expirationComponent
```
public T expirationComponent(ExpirationComponent value)
```
    The cache expiration configuration.
  - fileStore
```
public FileStore fileStore()
```
    The cache file store configuration.
  - fileStore
```
public T fileStore(FileStore value)
```
    The cache file store configuration.
  - noneStore
```
public NoneStore noneStore()
```
    A store-less configuration.
  - noneStore
```
public T noneStore(NoneStore value)
```
    A store-less configuration.
  - transactionComponent
```
public TransactionComponent transactionComponent()
```
    The cache transaction configuration.
  - transactionComponent
```
public T transactionComponent(TransactionComponent value)
```
    The cache transaction configuration.
  - lockingComponent
```
public LockingComponent lockingComponent()
```
    The locking configuration of the cache.
  - lockingComponent
```
public T lockingComponent(LockingComponent value)
```
    The locking configuration of the cache.
  - binaryJdbcStore
```
public BinaryJDBCStore binaryJdbcStore()
```
    The cache JDBC store configuration.
  - binaryJdbcStore
```
public T binaryJdbcStore(BinaryJDBCStore value)
```
    The cache JDBC store configuration.
  - mixedJdbcStore
```
public MixedJDBCStore mixedJdbcStore()
```
    The cache JDBC store configuration.
  - mixedJdbcStore
```
public T mixedJdbcStore(MixedJDBCStore value)
```
    The cache JDBC store configuration.
  - remoteStore
```
public RemoteStore remoteStore()
```
    The cache remote store configuration.
  - remoteStore
```
public T remoteStore(RemoteStore value)
```
    The cache remote store configuration.

Class LocalCache<T extends LocalCache>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocalCache

Method Detail

getKey

activations

activations

averageReadTime

averageReadTime

averageWriteTime

averageWriteTime

cacheStatus

cacheStatus

elapsedTime

elapsedTime

hitRatio

hitRatio

hits

hits

invalidations

invalidations

jndiName

jndiName

misses

misses

module

module

numberOfEntries

numberOfEntries

passivations

passivations

readWriteRatio

readWriteRatio

removeHits

removeHits

removeMisses

removeMisses

statisticsEnabled

statisticsEnabled

stores

stores

timeSinceReset

timeSinceReset

evictionComponent

evictionComponent

stringJdbcStore

stringJdbcStore

customStore

customStore

expirationComponent

expirationComponent

fileStore

fileStore

noneStore

noneStore

transactionComponent

transactionComponent

lockingComponent

lockingComponent

binaryJdbcStore

binaryJdbcStore

mixedJdbcStore

mixedJdbcStore

remoteStore

remoteStore