/*
* Copyright (c) 2019 Goldman Sachs.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v. 1.0 which accompany this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*/
package org.eclipse.collections.api.map;
import java.util.Map;
import java.util.Set;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
A FixedSizeMap is a map that may be mutated, but cannot grow or shrink in size.
/**
* A FixedSizeMap is a map that may be mutated, but cannot grow or shrink in size.
*/
public interface FixedSizeMap<K, V>
extends MutableMap<K, V>
{
Throws: - UnsupportedOperationException – the
clear
operation is not supported by this map.
/**
* @throws UnsupportedOperationException the {@code clear} operation is not supported by this map.
*/
@Override
void clear();
Throws: - UnsupportedOperationException – the
put
operation is not supported by this map.
/**
* @throws UnsupportedOperationException the {@code put} operation is not supported by this map.
*/
@Override
V put(K key, V value);
Throws: - UnsupportedOperationException – the
putAll
operation is not supported by this map.
/**
* @throws UnsupportedOperationException the {@code putAll} operation is not supported by this map.
*/
@Override
void putAll(Map<? extends K, ? extends V> map);
Throws: - UnsupportedOperationException – the
remove
operation is not supported by this map.
/**
* @throws UnsupportedOperationException the {@code remove} operation is not supported by this map.
*/
@Override
V remove(Object key);
Throws: - UnsupportedOperationException – the
removeKey
operation is not supported by this map.
/**
* @throws UnsupportedOperationException the {@code removeKey} operation is not supported by this map.
*/
@Override
V removeKey(K key);
Throws: - UnsupportedOperationException – the
removeAllKeys
operation is not supported by this map.
/**
* @throws UnsupportedOperationException the {@code removeAllKeys} operation is not supported by this map.
*/
@Override
boolean removeAllKeys(Set<? extends K> keys);
Throws: - UnsupportedOperationException – the
removeIf
operation is not supported by this map.
/**
* @throws UnsupportedOperationException the {@code removeIf} operation is not supported by this map.
*/
@Override
boolean removeIf(Predicate2<? super K, ? super V> predicate);
@Override
FixedSizeMap<K, V> tap(Procedure<? super V> procedure);
@Override
default FixedSizeMap<K, V> withMap(Map<? extends K, ? extends V> map)
{
this.putAll(map);
return this;
}
}