javax.persistence.Cacheable Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
package javax.persistence;

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

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

/**
 * Specifies whether an entity should be cached if caching is enabled when the value of the
 * persistence.xml caching element is ENABLE_SELECTIVE or
 * DISABLE_SELECTIVE. 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 Java Persistence 2.0
 */
@Target({TYPE})
@Retention(RUNTIME)
public @interface Cacheable
{

    /**
     * (Optional) Whether or not the entity should be cached.
     * @return Whether to cache it
     */
    boolean value() default true;
}