/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2012, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.cache.spi;

import org.hibernate.cache.CacheException;
import org.hibernate.cache.spi.access.AccessType;
import org.hibernate.cache.spi.access.NaturalIdRegionAccessStrategy;

Defines the contract for a cache region which will specifically be used to store naturalId data.
Author:Eric Dalquist, Steve Ebersole
/** * Defines the contract for a cache region which will specifically be used to * store naturalId data. * * @author Eric Dalquist * @author Steve Ebersole */
public interface NaturalIdRegion extends TransactionalDataRegion {
Build an access strategy for the requested access type.
Params:
  • accessType – The type of access strategy to build; never null.
Throws:
Returns:The appropriate strategy contract for accessing this region for the requested type of access.
/** * Build an access strategy for the requested access type. * * @param accessType The type of access strategy to build; never null. * @return The appropriate strategy contract for accessing this region * for the requested type of access. * @throws org.hibernate.cache.CacheException Usually indicates mis-configuration. */
public NaturalIdRegionAccessStrategy buildAccessStrategy(AccessType accessType) throws CacheException; }