JSR107 API and SPI 1.1.1 · javax.cache.management.CacheMXBean

Method Summary

Modifier and Type	Method and Description
public String	Returns: the fully qualified class name of the key type, or "java.lang.Object" if the type is undefined. getKeyType() Determines the required type of keys for this `Cache`, if any.
public String	Returns: the fully qualified class name of the value type, or "java.lang.Object" if the type is undefined. getValueType() Determines the required type of values for this `Cache`, if any.
public boolean	Returns: true if management is enabled isManagementEnabled() Checks whether management is enabled on this cache.
public boolean	Returns: `true` when a `Cache` is in "read-through" mode. isReadThrough() Determines if a `Cache` should operate in read-through mode.
public boolean	Returns: true if statistics collection is enabled isStatisticsEnabled() Checks whether statistics collection is enabled in this cache.
public boolean	Returns: true if the cache is store by value isStoreByValue() Whether storeByValue (true) or storeByReference (false).
public boolean	Returns: `true` when a `Cache` is in "write-through" mode. isWriteThrough() Determines if a `Cache` should operate in "write-through" mode.

Method Detail

getKeyType back to summary

getKeyType	back to summary
public String getKeyType() Determines the required type of keys for this `Cache`, if any. Returns:String the fully qualified class name of the key type, or "java.lang.Object" if the type is undefined.

public String getKeyType()

Determines the required type of keys for this Cache, if any.

Returns:String: the fully qualified class name of the key type, or "java.lang.Object" if the type is undefined.

getValueType back to summary

getValueType	back to summary
public String getValueType() Determines the required type of values for this `Cache`, if any. Returns:String the fully qualified class name of the value type, or "java.lang.Object" if the type is undefined.

public String getValueType()

Determines the required type of values for this Cache, if any.

Returns:String: the fully qualified class name of the value type, or "java.lang.Object" if the type is undefined.

isManagementEnabled back to summary

isManagementEnabled	back to summary
public boolean isManagementEnabled() Checks whether management is enabled on this cache. The default value is `false`. Returns:boolean true if management is enabled

public boolean isManagementEnabled()

Checks whether management is enabled on this cache.

The default value is false.

Returns:boolean: true if management is enabled

isReadThrough back to summary

isReadThrough	back to summary
public boolean isReadThrough() Determines if a `Cache` should operate in read-through mode. When in read-through mode, cache misses that occur due to cache entries not existing as a result of performing a "get" call via one of `Cache#get`, `Cache#getAll`, `Cache#getAndRemove` and/or `Cache#getAndReplace` will appropriately cause the configured `CacheLoader` to be invoked. The default value is `false`. Returns:boolean `true` when a `Cache` is in "read-through" mode. See Also `CacheLoader`

public boolean isReadThrough()

Determines if a Cache should operate in read-through mode.

When in read-through mode, cache misses that occur due to cache entries not existing as a result of performing a "get" call via one of Cache#get, Cache#getAll, Cache#getAndRemove and/or Cache#getAndReplace will appropriately cause the configured CacheLoader to be invoked.

The default value is false.

Returns:boolean: true when a Cache is in "read-through" mode.
See Also: CacheLoader

isStatisticsEnabled back to summary

isStatisticsEnabled	back to summary
public boolean isStatisticsEnabled() Checks whether statistics collection is enabled in this cache. The default value is `false`. Returns:boolean true if statistics collection is enabled

public boolean isStatisticsEnabled()

Checks whether statistics collection is enabled in this cache.

The default value is false.

Returns:boolean: true if statistics collection is enabled

isStoreByValue back to summary

isStoreByValue	back to summary
public boolean isStoreByValue() Whether storeByValue (true) or storeByReference (false). When true, both keys and values are stored by value. When false, both keys and values are stored by reference. Caches stored by reference are capable of mutation by any threads holding the reference. The effects are: if the key is mutated, then the key may not be retrievable or removable if the value is mutated, then all threads in the JVM can potentially observe those mutations, subject to the normal Java Memory Model rules. Storage by reference only applies to the local heap. If an entry is moved off heap it will need to be transformed into a representation. Any mutations that occur after transformation may not be reflected in the cache. When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache. The default value is `true`. Returns:boolean true if the cache is store by value

public boolean isStoreByValue()

Whether storeByValue (true) or storeByReference (false). When true, both keys and values are stored by value.

When false, both keys and values are stored by reference. Caches stored by reference are capable of mutation by any threads holding the reference. The effects are:

if the key is mutated, then the key may not be retrievable or removable
if the value is mutated, then all threads in the JVM can potentially observe those mutations, subject to the normal Java Memory Model rules.

Storage by reference only applies to the local heap. If an entry is moved off heap it will need to be transformed into a representation. Any mutations that occur after transformation may not be reflected in the cache.

When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.

The default value is true.

Returns:boolean: true if the cache is store by value

isWriteThrough back to summary

isWriteThrough	back to summary
public boolean isWriteThrough() Determines if a `Cache` should operate in "write-through" mode. When in "write-through" mode, cache updates that occur as a result of performing "put" operations called via one of `Cache#put`, `Cache#getAndRemove`, `Cache#removeAll`, `Cache#getAndPut` `Cache#getAndRemove`, `Cache#getAndReplace`, `Cache#invoke` `Cache#invokeAll` will appropriately cause the configured `CacheWriter` to be invoked. The default value is `false`. Returns:boolean `true` when a `Cache` is in "write-through" mode. See Also `CacheWriter`

public boolean isWriteThrough()

Determines if a Cache should operate in "write-through" mode.

When in "write-through" mode, cache updates that occur as a result of performing "put" operations called via one of Cache#put, Cache#getAndRemove, Cache#removeAll, Cache#getAndPut Cache#getAndRemove, Cache#getAndReplace, Cache#invoke Cache#invokeAll

will appropriately cause the configured CacheWriter to be invoked.

The default value is false.

Returns:boolean: true when a Cache is in "write-through" mode.
See Also: CacheWriter

public Interface CacheMXBean

Method Summary

Method Detail