CacheModule (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.inject.AbstractModule
- - com.google.gerrit.extensions.config.FactoryModule
  - - com.google.gerrit.server.cache.CacheModule

All Implemented Interfaces:

com.google.inject.Module

Direct Known Subclasses:

LdapModule, SearchingChangeCacheImpl.Module
```
public abstract class CacheModule
extends com.google.gerrit.extensions.config.FactoryModule
```
Miniature DSL to support binding Cache instances in Guice.

Constructor Summary

Constructors
Constructor and Description

CacheModule()

Constructors
Constructor and Description
`CacheModule()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected <K,V> CacheBinding<K,V>`	`cache(java.lang.String name, java.lang.Class<K> keyType, java.lang.Class<V> valType)` Declare a named in-memory cache.
`protected <K,V> CacheBinding<K,V>`	`cache(java.lang.String name, java.lang.Class<K> keyType, com.google.inject.TypeLiteral<V> valType)` Declare a named in-memory cache.
`protected <K,V> CacheBinding<K,V>`	`cache(java.lang.String name, com.google.inject.TypeLiteral<K> keyType, com.google.inject.TypeLiteral<V> valType)` Declare a named in-memory cache.
`protected <K extends java.io.Serializable,V extends java.io.Serializable> CacheBinding<K,V>`	`persist(java.lang.String name, java.lang.Class<K> keyType, java.lang.Class<V> valType)` Declare a named in-memory/on-disk cache.
`protected <K extends java.io.Serializable,V extends java.io.Serializable> CacheBinding<K,V>`	`persist(java.lang.String name, java.lang.Class<K> keyType, com.google.inject.TypeLiteral<V> valType)` Declare a named in-memory/on-disk cache.
`protected <K extends java.io.Serializable,V extends java.io.Serializable> CacheBinding<K,V>`	`persist(java.lang.String name, com.google.inject.TypeLiteral<K> keyType, com.google.inject.TypeLiteral<V> valType)` Declare a named in-memory/on-disk cache.

Methods inherited from class com.google.gerrit.extensions.config.FactoryModule
factory

Methods inherited from class com.google.inject.AbstractModule
addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

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

Constructor Detail
- CacheModule
```
public CacheModule()
```

Method Detail

cache

protected <K,V> CacheBinding<K,V> cache(java.lang.String name,
                            java.lang.Class<K> keyType,
                            java.lang.Class<V> valType)

Declare a named in-memory cache.

Type Parameters:: K - type of key used to lookup entries.; V - type of value stored by the cache.
Returns:: binding to describe the cache.

cache

protected <K,V> CacheBinding<K,V> cache(java.lang.String name,
                            java.lang.Class<K> keyType,
                            com.google.inject.TypeLiteral<V> valType)

Declare a named in-memory cache.

Type Parameters:: K - type of key used to lookup entries.; V - type of value stored by the cache.
Returns:: binding to describe the cache.

cache

protected <K,V> CacheBinding<K,V> cache(java.lang.String name,
                            com.google.inject.TypeLiteral<K> keyType,
                            com.google.inject.TypeLiteral<V> valType)

Declare a named in-memory cache.

Type Parameters:: K - type of key used to lookup entries.; V - type of value stored by the cache.
Returns:: binding to describe the cache.

persist

protected <K extends java.io.Serializable,V extends java.io.Serializable> CacheBinding<K,V> persist(java.lang.String name,
                                                                                        java.lang.Class<K> keyType,
                                                                                        java.lang.Class<V> valType)

Declare a named in-memory/on-disk cache.

Type Parameters:: K - type of key used to lookup entries.; V - type of value stored by the cache.
Returns:: binding to describe the cache.

persist

protected <K extends java.io.Serializable,V extends java.io.Serializable> CacheBinding<K,V> persist(java.lang.String name,
                                                                                        java.lang.Class<K> keyType,
                                                                                        com.google.inject.TypeLiteral<V> valType)

Declare a named in-memory/on-disk cache.

Type Parameters:: K - type of key used to lookup entries.; V - type of value stored by the cache.
Returns:: binding to describe the cache.

persist

protected <K extends java.io.Serializable,V extends java.io.Serializable> CacheBinding<K,V> persist(java.lang.String name,
                                                                                        com.google.inject.TypeLiteral<K> keyType,
                                                                                        com.google.inject.TypeLiteral<V> valType)

Declare a named in-memory/on-disk cache.

Type Parameters:: K - type of key used to lookup entries.; V - type of value stored by the cache.
Returns:: binding to describe the cache.

Class CacheModule

Constructor Summary

Method Summary

Methods inherited from class com.google.gerrit.extensions.config.FactoryModule

Methods inherited from class com.google.inject.AbstractModule

Methods inherited from class java.lang.Object

Constructor Detail

CacheModule

Method Detail

cache

cache

cache

persist

persist

persist