CacheOptions (ebean 12.3.3 API)

java.lang.Object
- io.ebeaninternal.server.core.CacheOptions

```
public class CacheOptions
extends Object
```
Options for controlling cache behaviour for a given type.

Field Summary

Fields
Modifier and Type Field Description

static CacheOptions NO_CACHING
Instance when no caching is used.

Constructor Summary

Constructors
Constructor Description

CacheOptions(io.ebean.annotation.Cache cache, String[] naturalKey)
Construct with cache annotation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String[]`	`getNaturalKey()`	Return the natural key property name.
`String`	`getRegion()`	Return the cache region name.
`static CacheOptions`	`invalidateQueryCache(String region)`
`boolean`	`isEnableBeanCache()`	Return true if bean caching is enabled.
`boolean`	`isEnableQueryCache()`	Return true if query caching is enabled.
`boolean`	`isInvalidateQueryCache()`	Return true if this is InvalidateQueryCache.
`boolean`	`isReadOnly()`	Return true if bean cache hits default to read only.

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

- Field Detail
  - NO_CACHING
```
public static final CacheOptions NO_CACHING
```
    Instance when no caching is used.
- Constructor Detail
  - CacheOptions
```
public CacheOptions(io.ebean.annotation.Cache cache,
                    String[] naturalKey)
```
    Construct with cache annotation.
- Method Detail
  - invalidateQueryCache
```
public static CacheOptions invalidateQueryCache(String region)
```
  - getRegion
```
public String getRegion()
```
    Return the cache region name.
  - isInvalidateQueryCache
```
public boolean isInvalidateQueryCache()
```
    Return true if this is InvalidateQueryCache. A Bean that itself isn't L2 cached but invalidates query cache entries that join to it.
  - isEnableBeanCache
```
public boolean isEnableBeanCache()
```
    Return true if bean caching is enabled.
  - isEnableQueryCache
```
public boolean isEnableQueryCache()
```
    Return true if query caching is enabled.
  - isReadOnly
```
public boolean isReadOnly()
```
    Return true if bean cache hits default to read only.
  - getNaturalKey
```
public String[] getNaturalKey()
```
    Return the natural key property name.