diff options
| author | Ben Culkin <scorpress@gmail.com> | 2020-04-13 18:43:13 -0400 |
|---|---|---|
| committer | Ben Culkin <scorpress@gmail.com> | 2020-04-13 18:43:13 -0400 |
| commit | f51f6da7319787348c38b875652b5c0e9f88c8aa (patch) | |
| tree | 943888fc724da2d2dedd89abec99dcbfcc089fd0 /src/main/java/bjc/esodata/Directory.java | |
| parent | 9052ed6da37af23ea82588d248f409e60a33c6cb (diff) | |
Cleanup pass
Pass to do some cleanups
Diffstat (limited to 'src/main/java/bjc/esodata/Directory.java')
| -rw-r--r-- | src/main/java/bjc/esodata/Directory.java | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/src/main/java/bjc/esodata/Directory.java b/src/main/java/bjc/esodata/Directory.java index 4147e17..e083cd8 100644 --- a/src/main/java/bjc/esodata/Directory.java +++ b/src/main/java/bjc/esodata/Directory.java @@ -7,21 +7,21 @@ package bjc.esodata; * be able to ensure that they can't write outside of it. * * @param <K> - * The key type of the map. + * The key type of the map. * @param <V> - * The value type of the map. + * The value type of the map. */ public interface Directory<K, V> { /** * Retrieves a given sub-directory. * * @param key - * The key to retrieve the sub-directory for. + * The key to retrieve the sub-directory for. * * @return The sub-directory under that name. * * @throws IllegalArgumentException - * If the given sub-directory doesn't exist. + * If the given sub-directory doesn't exist. */ Directory<K, V> getSubdirectory(K key); @@ -29,7 +29,7 @@ public interface Directory<K, V> { * Check if a given sub-directory exists. * * @param key - * The key to look for the sub-directory under. + * The key to look for the sub-directory under. * * @return Whether or not a sub-directory of that name exists. */ @@ -39,9 +39,9 @@ public interface Directory<K, V> { * Insert a sub-directory into the dictionary. * * @param key - * The name of the new sub-directory + * The name of the new sub-directory * @param value - * The sub-directory to insert + * The sub-directory to insert * * @return The old sub-directory attached to this key, or null if such a * sub-directory didn't exist @@ -54,13 +54,13 @@ public interface Directory<K, V> { * Will fail if a sub-directory of that name already exists. * * @param key - * The name of the new sub-directory. + * The name of the new sub-directory. * - * @return The new sub-directory, or null if one by that name already - * exists. + * @return The new sub-directory, or null if one by that name already exists. */ default Directory<K, V> newSubdirectory(final K key) { - if(hasSubdirectory(key)) return null; + if (hasSubdirectory(key)) + return null; final Directory<K, V> dir = new SimpleDirectory<>(); @@ -73,7 +73,7 @@ public interface Directory<K, V> { * Check if the directory contains a data-item under the given key. * * @param key - * The key to check for. + * The key to check for. * * @return Whether or not there is a data item for the given key. */ @@ -83,12 +83,12 @@ public interface Directory<K, V> { * Retrieve a given data-item from the directory. * * @param key - * The key to retrieve data for. + * The key to retrieve data for. * * @return The value for the given key. * * @throws IllegalArgumentException - * If no value exists for the given key. + * If no value exists for the given key. */ V getKey(K key); @@ -96,10 +96,10 @@ public interface Directory<K, V> { * Insert a data-item into the directory. * * @param key - * The key to insert into. + * The key to insert into. * * @param val - * The value to insert. + * The value to insert. * * @return The old value of key, or null if such a value didn't exist. */ |
