summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/funcdata/IMap.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/bjc/funcdata/IMap.java')
-rw-r--r--src/main/java/bjc/funcdata/IMap.java76
1 files changed, 38 insertions, 38 deletions
diff --git a/src/main/java/bjc/funcdata/IMap.java b/src/main/java/bjc/funcdata/IMap.java
index ba56578..dc5ee00 100644
--- a/src/main/java/bjc/funcdata/IMap.java
+++ b/src/main/java/bjc/funcdata/IMap.java
@@ -10,17 +10,17 @@ import java.util.function.Function;
* @author ben
*
* @param <KeyType>
- * The type of this map's keys.
+ * The type of this map's keys.
*
* @param <ValueType>
- * The type of this map's values.
+ * 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.
+ * The action to execute for each entry in the map.
*/
void forEach(BiConsumer<KeyType, ValueType> action);
@@ -28,7 +28,7 @@ public interface IMap<KeyType, ValueType> {
* Perform an action for each key in the map.
*
* @param action
- * The action to perform on each key in the map.
+ * The action to perform on each key in the map.
*/
default void forEachKey(final Consumer<KeyType> action) {
forEach((key, val) -> action.accept(key));
@@ -38,7 +38,7 @@ public interface IMap<KeyType, ValueType> {
* Perform an action for each value in the map.
*
* @param action
- * The action to perform on each value in the map.
+ * The action to perform on each value in the map.
*/
default void forEachValue(final Consumer<ValueType> action) {
forEach((key, val) -> action.accept(val));
@@ -48,7 +48,7 @@ public interface IMap<KeyType, ValueType> {
* Check if this map contains the specified key.
*
* @param key
- * The key to check.
+ * The key to check.
*
* @return Whether or not the map contains the key.
*/
@@ -58,32 +58,31 @@ public interface IMap<KeyType, ValueType> {
* Get the value assigned to the given key.
*
* @param key
- * The key to look for a value under.
+ * 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.
+ * 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.
+ * The key to attempt to retrieve.
*
* @param defaultValue
- * The value to return if the key doesn't exist.
+ * 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.
+ * @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) {
+ } catch (final IllegalArgumentException iaex) {
/*
- * We don't care about this, because it indicates a key
- * is missing.
+ * We don't care about this, because it indicates a key is missing.
*/
return defaultValue;
}
@@ -93,17 +92,18 @@ public interface IMap<KeyType, ValueType> {
* Add an entry to the map.
*
* @param key
- * The key to put the value under.
+ * The key to put the value under.
*
* @param val
- * The value to add.
+ * 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.
+ * @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.
+ * If the map implementation doesn't
+ * support modifying the map.
*/
ValueType put(KeyType key, ValueType val);
@@ -122,22 +122,22 @@ public interface IMap<KeyType, ValueType> {
}
/*
- * @NOTE Do we want this to be the semantics for transform, or do we
- * want to go to semantics using something like Isomorphism, or doing a
- * one-time bulk conversion of the values?
+ * @NOTE Do we want this to be the semantics for transform, or do we want to go
+ * to semantics using something like Isomorphism, or doing a one-time bulk
+ * conversion of the values?
*/
/**
* 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.
+ * 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.
+ * The new type of returned values.
*
* @param transformer
- * The function to use to transform values.
+ * The function to use to transform values.
*
* @return The map where each value will be transformed after lookup.
*/
@@ -146,8 +146,8 @@ public interface IMap<KeyType, ValueType> {
}
/**
- * Extends this map, creating a new map that will delegate queries to
- * the map, but store any added values itself.
+ * Extends this map, creating a new map that will delegate queries to the map,
+ * but store any added values itself.
*
* @return An extended map.
*/
@@ -157,12 +157,12 @@ public interface IMap<KeyType, ValueType> {
* Remove the value bound to the key.
*
* @param key
- * The key to remove from the map.
+ * 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.
+ * @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);
@@ -181,7 +181,7 @@ public interface IMap<KeyType, ValueType> {
default IList<ValueType> valueList() {
final IList<ValueType> returns = new FunctionalList<>();
- for(final KeyType key : keyList()) {
+ for (final KeyType key : keyList()) {
returns.add(get(key));
}