1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* esodata - data structures and other things, of varying utility
* Copyright 2022, Ben Culkin
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package bjc.esodata;
/**
* Represents a hierarchical map.
*
* What's useful about this is that you can hand sub-directories to people and
* be able to ensure that they can't write outside of it.
*
* @param <K>
* The key type of the map.
* @param <V>
* 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.
*
* @return The sub-directory under that name.
*
* @throws IllegalArgumentException
* If the given sub-directory doesn't exist.
*/
Directory<K, V> getSubdirectory(K key);
/**
* Check if a given sub-directory exists.
*
* @param key
* The key to look for the sub-directory under.
*
* @return Whether or not a sub-directory of that name exists.
*/
boolean hasSubdirectory(K key);
/**
* Insert a sub-directory into the dictionary.
*
* @param key
* The name of the new sub-directory
* @param value
* The sub-directory to insert
*
* @return The old sub-directory attached to this key, or null if such a
* sub-directory didn't exist
*/
Directory<K, V> putSubdirectory(K key, Directory<K, V> value);
/**
* Create a new sub-directory.
*
* Will fail if a sub-directory of that name already exists.
*
* @param key
* The name of the new sub-directory.
*
* @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;
final Directory<K, V> dir = new SimpleDirectory<>();
putSubdirectory(key, dir);
return dir;
}
/**
* Check if the directory contains a data-item under the given key.
*
* @param key
* The key to check for.
*
* @return Whether or not there is a data item for the given key.
*/
boolean containsKey(K key);
/**
* Retrieve a given data-item from the directory.
*
* @param key
* The key to retrieve data for.
*
* @return The value for the given key.
*
* @throws IllegalArgumentException
* If no value exists for the given key.
*/
V getKey(K key);
/**
* Insert a data-item into the directory.
*
* @param key
* The key to insert into.
*
* @param val
* The value to insert.
*
* @return The old value of key, or null if such a value didn't exist.
*/
V putKey(K key, V val);
}
|
