org.apache.solr.common.util.ObjectCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of solr-solrj Show documentation
Apache Solr Solrj
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.solr.common.util;

import java.io.Closeable;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Function;
import org.apache.solr.common.SolrCloseable;

/** Simple object cache with a type-safe accessor. */
public class ObjectCache extends MapBackedCache implements SolrCloseable {

  private final AtomicBoolean isClosed = new AtomicBoolean(false);

  public ObjectCache() {
    super(new ConcurrentHashMap<>());
  }

  private void ensureNotClosed() {
    if (isClosed.get()) {
      throw new RuntimeException("This ObjectCache is already closed.");
    }
  }

  @Override
  public Object put(String key, Object val) {
    ensureNotClosed();
    return super.put(key, val);
  }

  @Override
  public Object get(String key) {
    ensureNotClosed();
    return super.get(key);
  }

  @Override
  public Object remove(String key) {
    ensureNotClosed();
    return super.remove(key);
  }

  @Override
  public void clear() {
    ensureNotClosed();
    super.clear();
  }

  public  T get(String key, Class clazz) {
    Object o = get(key);
    if (o == null) {
      return null;
    } else {
      return clazz.cast(o);
    }
  }

  public  T computeIfAbsent(
      String key, Class clazz, Function mappingFunction) {
    ensureNotClosed();
    Object o = super.computeIfAbsent(key, mappingFunction);
    return clazz.cast(o);
  }

  @Override
  public boolean isClosed() {
    return isClosed.get();
  }

  @Override
  public void close() throws IOException {
    if (isClosed.compareAndSet(false, true)) {
      // Close any Closeable object which may have been stored into this cache.
      // This allows to tie some objects to the lifecycle of the object which
      // owns this ObjectCache, which is useful for plugins to register objects
      // which should be closed before being garbage-collected.
      for (Object value : map.values()) {
        if (value instanceof Closeable) {
          ((Closeable) value).close();
        }
      }
      map.clear();
    }
  }
}