org.ibatis.persist.Cacheable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbatis Show documentation

The jBATIS persistence framework will help you to significantly reduce the amount of Java code that you normally need to access a relational database. iBATIS simply maps JavaBeans to SQL statements using a very simple XML descriptor.

The newest version!

package org.ibatis.persist;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Specifies whether an entity should be cached. The value of the Cacheable annotation is inherited by
 * subclasses; it can be overridden by specifying Cacheable on a subclass.
 * 
 * 
 * Cacheable(false) means that the entity and its state must not be cached by the provider.
 * 
 * @since iBatis Persistence 1.0
 */
@Target({ TYPE })
@Retention(RUNTIME)
public @interface Cacheable {

    /**
     * (Optional) Whether or not the entity should be cached.
     */
    boolean value() default true;

    /**
     * (Optional) The cache type such as MEMORY, OSCACHE, EHCACHE or others.
     */
    String type() default "";

    /**
     * (Optional)
     */
    int minutes() default 600;
    
    /**
     * (Optional) The cache roots
     * @since 1.1
     */
    Class[] roots() default {};
}