Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix inconsistencies in unmodifiable maps. #1617

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix inconsistencies in unmodifiable maps. #1617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions eclipse-collections/src/main/java/org/eclipse/collections/impl/UnmodifiableMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.function.BiFunction;
import java.util.function.Function;

/**
* An unmodifiable view of a Map.
Expand Down Expand Up @@ -88,6 +90,60 @@ public void clear()
throw new UnsupportedOperationException("Cannot call clear() on " + this.getClass().getSimpleName());
}

@Override
public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function)
{
throw new UnsupportedOperationException("Cannot call replaceAll() on " + this.getClass().getSimpleName());
}

@Override
public V putIfAbsent(K key, V value)
{
throw new UnsupportedOperationException("Cannot call putIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public boolean remove(Object key, Object value)
{
throw new UnsupportedOperationException("Cannot call remove() on " + this.getClass().getSimpleName());
}

@Override
public boolean replace(K key, V oldValue, V newValue)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public V replace(K key, V value)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfPresent() on " + this.getClass().getSimpleName());
}

@Override
public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call compute() on " + this.getClass().getSimpleName());
}

@Override
public V merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call merge() on " + this.getClass().getSimpleName());
}

@Override
public Set<K> keySet()
{
Expand Down
55 changes: 55 additions & 0 deletions ...ns/src/main/java/org/eclipse/collections/impl/bimap/immutable/AbstractImmutableBiMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import java.util.Map;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;

import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.bag.ImmutableBag;
Expand Down Expand Up @@ -203,6 +204,60 @@ public void clear()
throw new UnsupportedOperationException("Cannot call clear() on " + this.getClass().getSimpleName());
}

@Override
public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function)
{
throw new UnsupportedOperationException("Cannot call replaceAll() on " + this.getClass().getSimpleName());
}

@Override
public V putIfAbsent(K key, V value)
{
throw new UnsupportedOperationException("Cannot call putIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public boolean remove(Object key, Object value)
{
throw new UnsupportedOperationException("Cannot call remove() on " + this.getClass().getSimpleName());
}

@Override
public boolean replace(K key, V oldValue, V newValue)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public V replace(K key, V value)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfAbsent(K key, java.util.function.Function<? super K, ? extends V> mappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfPresent() on " + this.getClass().getSimpleName());
}

@Override
public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call compute() on " + this.getClass().getSimpleName());
}

@Override
public V merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call merge() on " + this.getClass().getSimpleName());
}

@Override
public Set<K> keySet()
{
Expand Down
81 changes: 76 additions & 5 deletions ...llections/src/main/java/org/eclipse/collections/impl/bimap/mutable/UnmodifiableBiMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1133,25 +1133,48 @@ public void clear()
@Override
public V getIfAbsentPut(K key, Function0<? extends V> function)
{
throw new UnsupportedOperationException("Cannot call getIfAbsentPut() on " + this.getClass().getSimpleName());
V result = this.get(key);
if (this.isAbsent(result, key))
{
throw new UnsupportedOperationException("Cannot mutate " + this.getClass().getSimpleName());
}
return result;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implementations like these are debatable, but are done consistently elsewhere like in UnmodifiableMutableMap. The trait-based testing approach is applying identical assertions to all the unmodifiable map wrappers and exposing differences like these.

}

@Override
public V getIfAbsentPut(K key, V value)
{
throw new UnsupportedOperationException("Cannot call getIfAbsentPut() on " + this.getClass().getSimpleName());
V result = this.get(key);
if (this.isAbsent(result, key))
{
throw new UnsupportedOperationException("Cannot mutate " + this.getClass().getSimpleName());
}
return result;
}

@Override
public V getIfAbsentPutWithKey(K key, Function<? super K, ? extends V> function)
{
throw new UnsupportedOperationException("Cannot call getIfAbsentPutWithKey() on " + this.getClass().getSimpleName());
return this.getIfAbsentPutWith(key, function, key);
}

@Override
public <P> V getIfAbsentPutWith(K key, Function<? super P, ? extends V> function, P parameter)
public <P> V getIfAbsentPutWith(
K key,
Function<? super P, ? extends V> function,
P parameter)
{
throw new UnsupportedOperationException("Cannot call getIfAbsentPutWith() on " + this.getClass().getSimpleName());
V result = this.get(key);
if (this.isAbsent(result, key))
{
throw new UnsupportedOperationException("Cannot mutate " + this.getClass().getSimpleName());
}
return result;
}

private boolean isAbsent(V result, K key)
{
return result == null && !this.containsKey(key);
}

@Override
Expand Down Expand Up @@ -1219,4 +1242,52 @@ public MutableBiMap<K, V> withoutAllKeys(Iterable<? extends K> keys)
{
throw new UnsupportedOperationException("Cannot call withoutAllKeys() on " + this.getClass().getSimpleName());
}

@Override
public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function)
{
throw new UnsupportedOperationException("Cannot call replaceAll() on " + this.getClass().getSimpleName());
}

@Override
public V putIfAbsent(K key, V value)
{
throw new UnsupportedOperationException("Cannot call putIfAbsent() on " + this.getClass().getSimpleName());
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that other composite methods like putIfAbsent and the compute* methods all consistently throw, regardless of if the map would be mutated. These overrides make sure that the exception is consistently UnsupportedOperationException and that any lambdas passed into the compute* methods are never invoked.

}

@Override
public boolean remove(Object key, Object value)
{
throw new UnsupportedOperationException("Cannot call remove() on " + this.getClass().getSimpleName());
}

@Override
public boolean replace(K key, V oldValue, V newValue)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public V replace(K key, V value)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfAbsent(K key, java.util.function.Function<? super K, ? extends V> mappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfPresent() on " + this.getClass().getSimpleName());
}

@Override
public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call compute() on " + this.getClass().getSimpleName());
}
}
55 changes: 55 additions & 0 deletions ...ctions/src/main/java/org/eclipse/collections/impl/map/immutable/AbstractImmutableMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import java.util.Optional;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;

import org.eclipse.collections.api.bag.ImmutableBag;
import org.eclipse.collections.api.bag.MutableBag;
Expand Down Expand Up @@ -129,6 +130,60 @@ public void clear()
throw new UnsupportedOperationException("Cannot call clear() on " + this.getClass().getSimpleName());
}

@Override
public V merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call merge() on " + this.getClass().getSimpleName());
}

@Override
public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call compute() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfPresent() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfAbsent(K key, java.util.function.Function<? super K, ? extends V> mappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public V replace(K key, V value)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public boolean replace(K key, V oldValue, V newValue)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public boolean remove(Object key, Object value)
{
throw new UnsupportedOperationException("Cannot call remove() on " + this.getClass().getSimpleName());
}

@Override
public V putIfAbsent(K key, V value)
{
throw new UnsupportedOperationException("Cannot call putIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function)
{
throw new UnsupportedOperationException("Cannot call replaceAll() on " + this.getClass().getSimpleName());
}

@Override
public ImmutableSetMultimap<V, K> flip()
{
Expand Down
48 changes: 48 additions & 0 deletions .../java/org/eclipse/collections/impl/map/ordered/mutable/UnmodifiableMutableOrderedMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,54 @@ public void clear()
throw new UnsupportedOperationException("Cannot call clear() on " + this.getClass().getSimpleName());
}

@Override
public void replaceAll(BiFunction<? super K, ? super V, ? extends V> function)
{
throw new UnsupportedOperationException("Cannot call replaceAll() on " + this.getClass().getSimpleName());
}

@Override
public V putIfAbsent(K key, V value)
{
throw new UnsupportedOperationException("Cannot call putIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public boolean remove(Object key, Object value)
{
throw new UnsupportedOperationException("Cannot call remove() on " + this.getClass().getSimpleName());
}

@Override
public boolean replace(K key, V oldValue, V newValue)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public V replace(K key, V value)
{
throw new UnsupportedOperationException("Cannot call replace() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfAbsent(K key, java.util.function.Function<? super K, ? extends V> mappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfAbsent() on " + this.getClass().getSimpleName());
}

@Override
public V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call computeIfPresent() on " + this.getClass().getSimpleName());
}

@Override
public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)
{
throw new UnsupportedOperationException("Cannot call compute() on " + this.getClass().getSimpleName());
}

@Override
public Set<K> keySet()
{
Expand Down
Loading