com.levigo.jbig2.util.cache.Cache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of levigo-jbig2-imageio Show documentation

Java Image I/O plugin for reading JBIG2-compressed image data

The newest version!

/**
 * Copyright (C) 1995-2015 levigo holding gmbh.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package com.levigo.jbig2.util.cache;

public interface Cache {

/**
 * 
 * @param key
 * @param value
 * @param sizeEstimate
 * 
 * @return the old object, that was replaced if present. Otherwise {@code null}.
 */
  Object put(Object key, Object value, int sizeEstimate);

  Object get(Object key);

  /**
   * Removes all mappings from a map (optional operation).
   * 
   * @throws UnsupportedOperationException if {@code clear()} is not supported by the map.
   */
  void clear();

  /**
   * 
   * @param key
   * @return the removed object, if present. Otherwise {@code null}.
   */
  Object remove(Object key);
}