org.tio.utils.collection.IntObjectMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mica-net-utils Show documentation
Mica net is a net framework.
There is a newer version: 1.0.8
/*
 * Copyright 2014 The Netty Project
 *
 * The Netty Project 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:
 *
 * https://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.tio.utils.collection;

import java.util.Iterator;
import java.util.Map;

/**
 * Interface for a primitive map that uses {@code int}s as keys.
 *
 * @param  the value type stored in the map.
 * @author netty
 */
public interface IntObjectMap extends Map {

	/**
	 * A primitive entry in the map, provided by the iterator from {@link #entries()}
	 *
	 * @param  the value type stored in the map.
	 */
	interface PrimitiveEntry {
		/**
		 * Gets the key for this entry.
		 * @return keu
		 */
		int key();

		/**
		 * Gets the value for this entry.
		 * @return V
		 */
		V value();

		/**
		 * Sets the value for this entry.
		 * @param value value
		 */
		void setValue(V value);
	}

	/**
	 * Gets the value in the map with the specified key.
	 *
	 * @param key the key whose associated value is to be returned.
	 * @return the value or {@code null} if the key was not found in the map.
	 */
	V get(int key);

	/**
	 * Puts the given entry into the map.
	 *
	 * @param key   the key of the entry.
	 * @param value the value of the entry.
	 * @return the previous value for this key or {@code null} if there was no previous mapping.
	 */
	V put(int key, V value);

	/**
	 * Removes the entry with the specified key.
	 *
	 * @param key the key for the entry to be removed from this map.
	 * @return the previous value for the key, or {@code null} if there was no mapping.
	 */
	V remove(int key);

	/**
	 * Gets an iterable to traverse over the primitive entries contained in this map. As an optimization,
	 * the {@link PrimitiveEntry}s returned by the {@link Iterator} may change as the {@link Iterator}
	 * progresses. The caller should not rely on {@link PrimitiveEntry} key/value stability.
	 *
	 * @return entries
	 */
	Iterable> entries();

	/**
	 * Indicates whether or not this map contains a value for the specified key.
	 *
	 * @param key key
	 * @return is has key
	 */
	boolean containsKey(int key);
}