org.conqat.lib.commons.cache4j.SynchronizedCache Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of teamscale-lib-commons Show documentation

Provides common utility functions

There is a newer version: 2024.7.2

Show newest version

/*
 * Copyright (c) CQSE GmbH
 *
 * 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.conqat.lib.commons.cache4j;

import org.conqat.lib.commons.cache4j.backend.ICacheBackend;
import org.conqat.lib.commons.error.NeverThrownRuntimeException;
import org.conqat.lib.commons.factory.IParameterizedFactory;

/**
 * Cache implementation that is synchronized to support multi-threaded environments.
 * 
 * @param 
 *            the key type. This must have both {@link Object#equals(Object)} and
 *            {@link Object#hashCode()} correctly implemented.
 * @param 
 *            the value type. It is generally recommended to use an immutable type here, but this is
 *            not required.
 * @param 
 *            the type of exception thrown. If no exception will be throws, use
 *            {@link NeverThrownRuntimeException}.
 */
public class SynchronizedCache extends BasicCache {

	/** Constructor. */
	public SynchronizedCache(String name, IParameterizedFactory factory, ICacheBackend backend) {
		super(name, factory, backend);
	}

	/**
	 * {@inheritDoc}
	 * 
	 * Overridden to provide synchronization.
	 */
	@Override
	public synchronized V obtain(K key) throws X {
		return super.obtain(key);
	}
}