summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java
diff options
context:
space:
mode:
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java')
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java188
1 files changed, 0 insertions, 188 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java b/BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java
deleted file mode 100644
index 0ee7375..0000000
--- a/BJC-Utils2/src/main/java/bjc/utils/funcdata/IMap.java
+++ /dev/null
@@ -1,188 +0,0 @@
-package bjc.utils.funcdata;
-
-import java.util.function.BiConsumer;
-import java.util.function.Consumer;
-import java.util.function.Function;
-
-/**
- * Functional wrapper over map providing some useful things.
- *
- * @author ben
- *
- * @param <KeyType>
- * The type of this map's keys.
- *
- * @param <ValueType>
- * The type of this map's values.
- */
-public interface IMap<KeyType, ValueType> {
- /**
- * Execute an action for each entry in the map.
- *
- * @param action
- * the action to execute for each entry in the map.
- */
- void forEach(BiConsumer<KeyType, ValueType> action);
-
- /**
- * Perform an action for each key in the map.
- *
- * @param action
- * The action to perform on each key in the map.
- */
- default void forEachKey(final Consumer<KeyType> action) {
- forEach((key, val) -> action.accept(key));
- }
-
- /**
- * Perform an action for each value in the map.
- *
- * @param action
- * The action to perform on each value in the map.
- */
- default void forEachValue(final Consumer<ValueType> action) {
- forEach((key, val) -> action.accept(val));
- }
-
- /**
- * Check if this map contains the specified key.
- *
- * @param key
- * The key to check.
- *
- * @return Whether or not the map contains the key.
- */
- boolean containsKey(KeyType key);
-
- /**
- * Get the value assigned to the given key.
- *
- * @param key
- * The key to look for a value under.
- *
- * @return The value of the key.
- */
- ValueType get(KeyType key);
-
- /**
- * Get a value from the map, and return a default value if the key
- * doesn't exist.
- *
- * @param key
- * The key to attempt to retrieve.
- *
- * @param defaultValue
- * The value to return if the key doesn't exist.
- *
- * @return The value associated with the key, or the default value if
- * the key doesn't exist.
- */
- default ValueType getOrDefault(final KeyType key, final ValueType defaultValue) {
- try {
- return get(key);
- } catch (final IllegalArgumentException iaex) {
- /*
- * We don't care about this, because it indicates a key
- * is missing.
- */
- return defaultValue;
- }
- }
-
- /**
- * Add an entry to the map.
- *
- * @param key
- * The key to put the value under.
- *
- * @param val
- * The value to add.
- *
- * @return The previous value of the key in the map, or null if the key
- * wasn't in the map. However, note that it may also return null
- * if the key was set to null.
- *
- * @throws UnsupportedOperationException
- * if the map implementation doesn't support modifying
- * the map
- */
- ValueType put(KeyType key, ValueType val);
-
- /**
- * Delete all the values in the map.
- */
- default void clear() {
- keyList().forEach(key -> remove(key));
- }
-
- /**
- * Get the number of entries in this map.
- *
- * @return The number of entries in this map.
- */
- default int size() {
- return keyList().getSize();
- }
-
- /**
- * Transform the values returned by this map.
- *
- * NOTE: This transform is applied once for each lookup of a value, so
- * the transform passed should be a proper function, or things will
- * likely not work as expected.
- *
- * @param <V2>
- * The new type of returned values.
- *
- * @param transformer
- * The function to use to transform values.
- *
- * @return The map where each value will be transformed after lookup.
- */
- default <V2> IMap<KeyType, V2> transform(final Function<ValueType, V2> transformer) {
- return new TransformedValueMap<>(this, transformer);
- }
-
- /**
- * Extends this map, creating a new map that will delegate queries to
- * the map, but store any added values itself.
- *
- * @return An extended map.
- */
- IMap<KeyType, ValueType> extend();
-
- /**
- * Remove the value bound to the key.
- *
- * @param key
- * The key to remove from the map.
- *
- * @return The previous value for the key in the map, or null if the key
- * wasn't in the class. NOTE: Just because you received null,
- * doesn't mean the map wasn't changed. It may mean that someone
- * put a null value for that key into the map.
- */
- ValueType remove(KeyType key);
-
- /**
- * Get a list of all the keys in this map.
- *
- * @return A list of all the keys in this map.
- */
- IList<KeyType> keyList();
-
- /**
- * Get a list of the values in this map.
- *
- * @return A list of values in this map.
- */
- default IList<ValueType> valueList() {
- final IList<ValueType> returns = new FunctionalList<>();
-
- for (final KeyType key : keyList()) {
- returns.add(get(key));
- }
-
- return returns;
- }
-}