Package org.apache.ibatis.annotations

Annotation Interface CacheNamespace

@Documented @Retention(RUNTIME) @Target(TYPE) public @interface CacheNamespace
The annotation that specify to use cache on namespace(e.g. mapper interface).

How to use: 

 @CacheNamespace(implementation = CustomCache.class, properties = {
   @Property(name = "host", value = "${mybatis.cache.host}"),
   @Property(name = "port", value = "${mybatis.cache.port}"),
   @Property(name = "name", value = "usersCache")
 })
 public interface UserMapper {
   // ...
 }
Author:
Clinton Begin, Kazuki Shimizu

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    blocking
    Returns whether block the cache at request time or not.
    Class<? extends Cache>
    eviction
    Returns the cache evicting implementation type to use.
    long
    flushInterval
    Returns the flush interval.
    Class<? extends Cache>
    implementation
    Returns the cache implementation type to use.
    Property[]
    properties
    Returns property values for a implementation object.
    boolean
    readWrite
    Returns whether use read/write cache.
    int
    size
    Return the cache size.

  • Element Details

    • implementation

      Class<? extends Cache> implementation
      Returns the cache implementation type to use.
      Returns:
      the cache implementation type
      Default:
      org.apache.ibatis.cache.impl.PerpetualCache.class

    • eviction

      Class<? extends Cache> eviction
      Returns the cache evicting implementation type to use.
      Returns:
      the cache evicting implementation type
      Default:
      org.apache.ibatis.cache.decorators.LruCache.class

    • flushInterval

      long flushInterval
      Returns the flush interval.
      Returns:
      the flush interval
      Default:
      0L

    • size

      int size
      Return the cache size.
      Returns:
      the cache size
      Default:
      1024

    • readWrite

      boolean readWrite
      Returns whether use read/write cache.
      Returns:
      true if use read/write cache; false if otherwise
      Default:
      true

    • blocking

      boolean blocking
      Returns whether block the cache at request time or not.
      Returns:
      true if block the cache; false if otherwise
      Default:
      false

    • properties

      Property[] properties
      Returns property values for a implementation object.
      Returns:
      property values
      Since:
      3.4.2
      Default:
      {}