javax.persistence.SharedCacheMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ow2-jpa-2.0-spec Show documentation

JPA API of Java EE 6.0

The newest version!

/*
 * Copyright 2010 Bull S.A.S.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package javax.persistence;

/**
 * The enum javax.persistence.SharedCacheMode defines the use of caching. The persis- tence.xml shared-cache-mode element has no
 * default value. The getSharedCacheMode method must return UNSPECIFIED if the shared-cache-mode element has not been specified
 * for the persistence unit.
 * @see JPA 2.0 specification
 * @author Florent Benoit
 * @since JPA 2.0 version.
 */
public enum SharedCacheMode {
    /**
     * All entities and entity-related state and data are cached.
     */
    ALL,

    /**
     * Caching is disabled for the persistence unit.
     */
    NONE,

    /**
     * Caching is enabled for all entities for Cacheable(true) is specified.
     */
    ENABLE_SELECTIVE,

    /**
     * Caching is enabled for all entities except those for which Cacheable(false) is specified.
     */
    DISABLE_SELECTIVE,

    /**
     * Caching behavior is undefined: provider-specific defaults may apply.
     */
    UNSPECIFIED
}