com.avaje.ebean.annotation.CacheStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation
Ebean
There is a newer version: 2.8.1
/**
 * Copyright (C) 2009  Robin Bygrave
 * 
 * This file is part of Ebean.
 * 
 * Ebean is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *  
 * Ebean is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Ebean; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA  
 */
package com.avaje.ebean.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.avaje.ebean.Query;
import com.avaje.ebean.Query.UseIndex;

/**
 * Specify the default cache use specific entity type.
 */
@Target( { ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface CacheStrategy {

	/**
	 * When set to true the bean cache will be used unless explicitly stated
	 * not to in a query via {@link Query#setUseCache(boolean)}.
	 */
	boolean useBeanCache() default true;

	/**
	 * When set to true the beans returned from the cache will be treated as
	 * readOnly (effectively immutable) and this means they can be safely 
	 * shared by many users.
	 * 
	 * If this is false then a copy of the bean is given back to the application
	 * and so the application code that modify that bean.
	 * 
	 * 
	 * If you try to modify a readOnly bean it will throw an IllegalStateException.
	 * 
	 */
	boolean readOnly() default false;

	/**
	 * Specify a query that can be used to warm the cache.
	 * 
	 * All the beans fetched by this query will be loaded into the bean cache and
	 * the query itself will be loaded into the query cache.
	 * 
	 * 
	 * The warming query will typically be executed at startup time after a short delay 
	 * (defaults to a 30 seconds delay).
	 * 
	 */
	String warmingQuery() default "";
	
	/**
	 * Default setting for using a lucene index if it has been defined on this bean type.
	 */
	UseIndex useIndex() default UseIndex.DEFAULT;
};