All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.ehcache.UserManagedCache Maven / Gradle / Ivy

There is a newer version: 3.10.8
Show newest version
/*
 * Copyright Terracotta, Inc.
 *
 * 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 org.ehcache;

import java.io.Closeable;

/**
 * Represents a {@link Cache} that is not managed by a {@link org.ehcache.CacheManager CacheManager}.
 * 

* These caches must be {@link #close() closed} in order to release all their resources. * * @param the key type for the cache * @param the value type for the cache */ public interface UserManagedCache extends Cache, Closeable { /** * Transitions this {@code UserManagedCache} to {@link org.ehcache.Status#AVAILABLE AVAILABLE}. *

* If an error occurs before the {@code UserManagedCache} is {@code AVAILABLE}, it will revert to * {@link org.ehcache.Status#UNINITIALIZED UNINITIALIZED} and attempt to properly release all resources. * * @throws IllegalStateException if the {@code UserManagedCache} is not {@code UNINITIALIZED} * @throws StateTransitionException if the {@code UserManagedCache} could not be made {@code AVAILABLE} */ void init() throws StateTransitionException; /** * Transitions this {@code UserManagedCache} to {@link Status#UNINITIALIZED UNINITIALIZED}. *

* This will release all resources held by this cache. *

* Failure to release a resource will not prevent other resources from being released. * * @throws StateTransitionException if the {@code UserManagedCache} could not reach {@code UNINITIALIZED} cleanly * @throws IllegalStateException if the {@code UserManagedCache} is not {@code AVAILABLE} */ @Override void close() throws StateTransitionException; /** * Returns the current {@link org.ehcache.Status Status} of this {@code UserManagedCache}. * * @return the current {@code Status} */ Status getStatus(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy