Skip to content

Commit fd2dd6d

Browse files
committed
PrefService: deprecate bad map/list/iterable sigs
Pattern should always be get(class, name) and set(class, name, value). The methods not conforming to this pattern are now deprecated.
1 parent fdc342c commit fd2dd6d

File tree

2 files changed

+60
-24
lines changed

2 files changed

+60
-24
lines changed

src/main/java/org/scijava/prefs/DefaultPrefService.java

Lines changed: 39 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,16 @@ public long getLong(final Class<?> c, final String name,
105105
return prefs(c).getLong(key(c, name), defaultValue);
106106
}
107107

108+
@Override
109+
public Map<String, String> getMap(final Class<?> c, final String name) {
110+
return prefs(c).node(key(c, name)).getMap();
111+
}
112+
113+
@Override
114+
public List<String> getList(final Class<?> c, final String name) {
115+
return prefs(c).node(key(c, name)).getList();
116+
}
117+
108118
@Override
109119
public void put(final Class<?> c, final String name, final String value) {
110120
prefs(c).put(key(c, name), value);
@@ -135,6 +145,20 @@ public void put(final Class<?> c, final String name, final long value) {
135145
prefs(c).putLong(key(c, name), value);
136146
}
137147

148+
@Override
149+
public void put(final Class<?> c, final String name,
150+
final Map<String, String> value)
151+
{
152+
prefs(c).node(key(c, name)).putMap(value);
153+
}
154+
155+
@Override
156+
public void put(final Class<?> c, final String name,
157+
final List<String> value)
158+
{
159+
prefs(c).node(key(c, name)).putList(value);
160+
}
161+
138162
@Override
139163
public void clear(final Class<?> c) {
140164
prefs(c).clear();
@@ -156,46 +180,41 @@ public void remove(final Class<?> prefClass, final String name) {
156180
prefs(prefClass).remove(key(prefClass, name));
157181
}
158182

183+
@Deprecated
159184
@Override
160185
public void putMap(final Class<?> prefClass, final Map<String, String> map,
161186
final String name)
162187
{
163-
prefs(prefClass).node(key(prefClass, name)).putMap(map);
188+
put(prefClass, name, map);
164189
}
165190

191+
@Deprecated
166192
@Override
167193
public void putMap(final Class<?> prefClass, final Map<String, String> map) {
168194
prefs(prefClass).putMap(map);
169195
}
170196

171-
@Override
172-
public Map<String, String> getMap(final Class<?> prefClass, final String name)
173-
{
174-
return prefs(prefClass).node(key(prefClass, name)).getMap();
175-
}
176-
197+
@Deprecated
177198
@Override
178199
public Map<String, String> getMap(final Class<?> prefClass) {
179200
return prefs(prefClass).getMap();
180201
}
181202

203+
@Deprecated
182204
@Override
183205
public void putList(final Class<?> prefClass, final List<String> list,
184206
final String name)
185207
{
186-
prefs(prefClass).node(key(prefClass, name)).putList(list);
208+
put(prefClass, name, list);
187209
}
188210

211+
@Deprecated
189212
@Override
190213
public void putList(final Class<?> prefClass, final List<String> list) {
191214
prefs(prefClass).putList(list);
192215
}
193216

194-
@Override
195-
public List<String> getList(final Class<?> prefClass, final String name) {
196-
return prefs(prefClass).node(key(prefClass, name)).getList();
197-
}
198-
217+
@Deprecated
199218
@Override
200219
public List<String> getList(final Class<?> prefClass) {
201220
return prefs(prefClass).getList();
@@ -207,10 +226,16 @@ public Iterable<String> getIterable(final Class<?> prefClass, final String name)
207226
}
208227

209228
@Override
210-
public void putIterable(final Class<?> prefClass, final Iterable<String> iterable, final String name) {
229+
public void putIterable(final Class<?> prefClass, final String name, final Iterable<String> iterable) {
211230
prefs(prefClass).node(key(prefClass, name)).putIterable(iterable);
212231
}
213232

233+
@Deprecated
234+
@Override
235+
public void putIterable(final Class<?> prefClass, final Iterable<String> iterable, final String name) {
236+
putIterable(prefClass, name, iterable);
237+
}
238+
214239
// -- Deprecated methods --
215240

216241
@Deprecated

src/main/java/org/scijava/prefs/PrefService.java

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ public interface PrefService extends SciJavaService {
5959

6060
long getLong(Class<?> c, String name, long defaultValue);
6161

62+
Map<String, String> getMap(Class<?> c, String name);
63+
64+
List<String> getList(Class<?> c, String name);
65+
6266
void put(Class<?> c, String name, String value);
6367

6468
void put(Class<?> c, String name, boolean value);
@@ -71,6 +75,10 @@ public interface PrefService extends SciJavaService {
7175

7276
void put(Class<?> c, String name, long value);
7377

78+
void put(Class<?> c, String name, Map<String, String> value);
79+
80+
void put(Class<?> c, String name, List<String> list);
81+
7482
void clear(Class<?> c);
7583

7684
/** Clears everything. */
@@ -87,48 +95,51 @@ public interface PrefService extends SciJavaService {
8795
/**
8896
* Puts a Map into the preferences, indexed under the specified class.
8997
*/
98+
@Deprecated
9099
void putMap(Class<?> prefClass, Map<String, String> map, String name);
91100

92101
/**
93102
* Puts a Map into the preferences, indexed under the given class.
94103
*/
104+
@Deprecated
95105
void putMap(Class<?> prefClass, Map<String, String> map);
96106

97-
/**
98-
* Gets a map from the preferences, indexed under the specified class.
99-
*/
100-
Map<String, String> getMap(Class<?> prefClass, String name);
101-
102107
/** Gets a Map from the preferences. */
108+
@Deprecated
103109
Map<String, String> getMap(Class<?> prefClass);
104110

105111
/**
106112
* Puts a list into the preferences, indexed under the specified class.
107113
*/
114+
@Deprecated
108115
void putList(Class<?> prefClass, List<String> list, String name);
109116

110117
/** Puts a list into the preferences. */
118+
@Deprecated
111119
void putList(Class<?> prefClass, List<String> list);
112120

113-
/**
114-
* Gets a List from the preferences, indexed under the specified class.
115-
*/
116-
List<String> getList(Class<?> prefClass, String name);
117-
118121
/**
119122
* Gets a List from the preferences. Returns an empty list if nothing in
120123
* prefs.
121124
*/
125+
@Deprecated
122126
List<String> getList(Class<?> prefClass);
123127

124128
/**
125129
* Puts an iterable into the preferences.
126130
*/
131+
void putIterable(Class<?> prefClass, String name, Iterable<String> iterable);
132+
133+
/**
134+
* Puts an iterable into the preferences.
135+
*/
136+
@Deprecated
127137
void putIterable(Class<?> prefClass, Iterable<String> iterable, String name);
128138

129139
/**
130140
* Gets an iterable from the preferences.
131141
*/
142+
@Deprecated
132143
Iterable<String> getIterable(Class<?> prefClass, String name);
133144

134145
// -- Deprecated methods --

0 commit comments

Comments
 (0)