001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.collections4;
018
019import java.util.Collection;
020import java.util.Set;
021
022/**
023 * The "read" subset of the {@link java.util.Map} interface.
024 *
025 * @since 4.0
026 * @version $Id: Get.html 887892 2013-11-24 13:43:45Z tn $
027 *
028 * @see Put
029 */
030public interface Get<K, V> {
031
032    /**
033     * @see java.util.Map#containsKey(Object)
034     */
035    boolean containsKey(Object key);
036
037    /**
038     * @see java.util.Map#containsValue(Object)
039     */
040    boolean containsValue(Object value);
041
042    /**
043     * @see java.util.Map#entrySet()
044     */
045    Set<java.util.Map.Entry<K, V>> entrySet();
046
047    /**
048     * @see java.util.Map#get(Object)
049     */
050    V get(Object key);
051
052    /**
053     * @see java.util.Map#remove(Object)
054     */
055    V remove(Object key);
056
057    /**
058     * @see java.util.Map#isEmpty()
059     */
060    boolean isEmpty();
061
062    /**
063     * @see java.util.Map#keySet()
064     */
065    Set<K> keySet();
066
067    /**
068     * @see java.util.Map#size()
069     */
070    int size();
071
072    /**
073     * @see java.util.Map#values()
074     */
075    Collection<V> values();
076
077}