org.scijava.prefs

Interface PrefService

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Identifiable, Initializable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, SciJavaService, Service, Versioned

All Known Implementing Classes:

AbstractPrefService, DefaultPrefService

public interface PrefService
extends SciJavaService

Service for storing and retrieving arbitrary preferences.

Author:

Mark Hiner

Method Summary

Modifier and Type	Method and Description
void	clear(Class<?> c) Deletes all of the given Class's keys from persistent storage.
void	clear(Class<?> c, String name) Deprecated. Use remove(Class, String).
default void	clear(String key) Deprecated. Use remove(Class, String) or clear(Class).
void	clear(String absolutePath, String key) Deprecated. Use remove(Class, String).
void	clearAll() Deletes all information from the data store.
default String	get(Class<?> c, String name) Gets a persisted key as a String.
String	get(Class<?> c, String name, String defaultValue) Gets a persisted key as a String.
default String	get(String name) Deprecated. Use get(Class, String).
default String	get(String name, String defaultValue) Deprecated. Use get(Class, String, String).
boolean	getBoolean(Class<?> c, String name, boolean defaultValue) Gets a persisted key as a boolean.
default boolean	getBoolean(String name, boolean defaultValue) Deprecated. Use getBoolean(Class, String, boolean).
double	getDouble(Class<?> c, String name, double defaultValue) Gets a persisted key as a double.
default double	getDouble(String name, double defaultValue) Deprecated. Use getDouble(Class, String, double).
float	getFloat(Class<?> c, String name, float defaultValue) Gets a persisted key as a float.
default float	getFloat(String name, float defaultValue) Deprecated. Use getFloat(Class, String, float).
int	getInt(Class<?> c, String name, int defaultValue) Gets a persisted key as an int.
default int	getInt(String name, int defaultValue) Deprecated. Use getInt(Class, String, int).
Iterable<String>	getIterable(Class<?> c, String name) Deprecated. Use getList(Class, String).
default Iterable<String>	getIterable(String key) Deprecated. User getList(Class, String).
List<String>	getList(Class<?> c) Deprecated. Use getList(Class, String).
List<String>	getList(Class<?> c, String name) Gets a persisted key as a List.
default List<String>	getList(String key) Deprecated. Use getList(Class, String).
List<String>	getList(String absolutePath, String key) Deprecated. Use getList(Class, String).
long	getLong(Class<?> c, String name, long defaultValue) Gets a persisted key as a long.
default long	getLong(String name, long defaultValue) Deprecated. Use getLong(Class, String, long).
Map<String,String>	getMap(Class<?> c) Deprecated. Use getMap(Class, String).
Map<String,String>	getMap(Class<?> c, String name) Gets a persisted key as a Map.
default Map<String,String>	getMap(String key) Deprecated. Use getMap(Class, String).
Map<String,String>	getMap(String absolutePath, String key) Deprecated. Use getMap(Class, String).
void	put(Class<?> c, String name, boolean value) Saves a key/value pair in persistent storage.
void	put(Class<?> c, String name, double value) Saves a key/value pair in persistent storage.
void	put(Class<?> c, String name, float value) Saves a key/value pair in persistent storage.
void	put(Class<?> c, String name, int value) Saves a key/value pair in persistent storage.
void	put(Class<?> c, String name, Iterable<String> value) Saves a key/value pair in persistent storage.
void	put(Class<?> c, String name, long value) Saves a key/value pair in persistent storage.
void	put(Class<?> c, String name, Map<String,String> value) Saves a key/value pair in persistent storage.
void	put(Class<?> c, String name, String value) Saves a key/value pair in persistent storage.
default void	put(String name, boolean value) Deprecated. Use put(Class, String, boolean).
default void	put(String name, double value) Deprecated. Use put(Class, String, double).
default void	put(String name, float value) Deprecated. Use put(Class, String, float).
default void	put(String name, int value) Deprecated. Use put(Class, String, int).
default void	put(String name, long value) Deprecated. Use put(Class, String, long).
default void	put(String name, String value) Deprecated. Use put(Class, String, String).
default void	putIterable(Class<?> c, Iterable<String> iterable, String name) Deprecated. Use put(Class, String, Iterable).
default void	putIterable(Iterable<String> iterable, String key) Deprecated. Use put(Class, String, Iterable).
void	putList(Class<?> c, List<String> list) Deprecated. Use put(Class, String, Iterable).
default void	putList(Class<?> c, List<String> list, String name) Deprecated. Use put(Class, String, Iterable).
default void	putList(List<String> list, String key) Deprecated. Use put(Class, String, Iterable).
void	putList(String absolutePath, List<String> list) Deprecated. Use put(Class, String, Iterable).
void	putList(String absolutePath, List<String> list, String key) Deprecated. Use put(Class, String, Iterable).
void	putMap(Class<?> c, Map<String,String> map) Deprecated. Use put(Class, String, Map).
default void	putMap(Class<?> c, Map<String,String> map, String name) Deprecated. Use put(Class, String, Map).
default void	putMap(Map<String,String> map, String key) Deprecated. Use put(Class, String, Map).
void	putMap(String absolutePath, Map<String,String> map) Deprecated. Use put(Class, String, Map).
void	putMap(String absolutePath, Map<String,String> map, String key) Deprecated. Use put(Class, String, Map).
void	remove(Class<?> c, String name) Deletes a key from persistent storage.
void	remove(String absolutePath, String key) Deprecated. Use remove(Class, String).

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

get

default String get(Class<?> c,
                   String name)

Gets a persisted key as a String.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

Returns:

The value of the key as a String, or null if the key is not present.

get

String get(Class<?> c,
           String name,
           String defaultValue)

Gets a persisted key as a String.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

defaultValue - The value to return if the key is not present.

Returns:

The value of the key as a String.

getBoolean

boolean getBoolean(Class<?> c,
                   String name,
                   boolean defaultValue)

Gets a persisted key as a boolean.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

defaultValue - The value to return if the key is not present.

Returns:

The value of the key as a boolean.

getDouble

double getDouble(Class<?> c,
                 String name,
                 double defaultValue)

Gets a persisted key as a double.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

defaultValue - The value to return if the key is not present.

Returns:

The value of the key as a double.

getFloat

float getFloat(Class<?> c,
               String name,
               float defaultValue)

Gets a persisted key as a float.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

defaultValue - The value to return if the key is not present.

Returns:

The value of the key as a float.

getInt

int getInt(Class<?> c,
           String name,
           int defaultValue)

Gets a persisted key as an int.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

defaultValue - The value to return if the key is not present.

Returns:

The value of the key as an int.

getLong

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

Gets a persisted key as a long.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

defaultValue - The value to return if the key is not present.

Returns:

The value of the key as an long.

getMap

Map<String,String> getMap(Class<?> c,
                          String name)

Gets a persisted key as a Map.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

Returns:

The value of the key as an Map, or null if the key is not present.

getList

List<String> getList(Class<?> c,
                     String name)

Gets a persisted key as a List.

Parameters:

c - The class with which the key is associated.

name - The key to retrieve.

Returns:

The value of the key as an List, or null if the key is not present.

put

void put(Class<?> c,
         String name,
         String value)

Saves a key/value pair in persistent storage.

Parameters:

c - The class with which the key/value pair is associated.

name - The key where the value should be stored.

value - The value to store.

See Also:

get(Class, String), get(Class, String, String)

put

void put(Class<?> c,
         String name,
         boolean value)

Saves a key/value pair in persistent storage.

Parameters:

c - The class with which the key/value pair is associated.

name - The key where the value should be stored.

value - The value to store.

See Also:

getBoolean(Class, String, boolean)

put

void put(Class<?> c,
         String name,
         double value)

Saves a key/value pair in persistent storage.

Parameters:

c - The class with which the key/value pair is associated.

name - The key where the value should be stored.

value - The value to store.

See Also:

getDouble(Class, String, double)

put

void put(Class<?> c,
         String name,
         float value)

Saves a key/value pair in persistent storage.

Parameters:

c - The class with which the key/value pair is associated.

name - The key where the value should be stored.

value - The value to store.

See Also:

getFloat(Class, String, float)

put

void put(Class<?> c,
         String name,
         int value)

Saves a key/value pair in persistent storage.

Parameters:

c - The class with which the key/value pair is associated.

name - The key where the value should be stored.

value - The value to store.

See Also:

getInt(Class, String, int)

put

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

Saves a key/value pair in persistent storage.

Parameters:

c - The class with which the key/value pair is associated.

name - The key where the value should be stored.

value - The value to store.

See Also:

getLong(Class, String, long)

put

void put(Class<?> c,
         String name,
         Map<String,String> value)

Saves a key/value pair in persistent storage.

Parameters:

c - The class with which the key/value pair is associated.

name - The key where the value should be stored.

value - The value to store.

See Also:

getMap(Class, String)

put

void put(Class<?> c,
         String name,
         Iterable<String> value)

Saves a key/value pair in persistent storage.

Parameters:

c - The class with which the key/value pair is associated.

name - The key where the value should be stored.

value - The value to store.

See Also:

getList(Class, String)

remove

void remove(Class<?> c,
            String name)

Deletes a key from persistent storage.

Parameters:

c - The class with which the key is associated.

name - The key to remove.

clear

void clear(Class<?> c)

Deletes all of the given Class's keys from persistent storage.

Parameters:

c - The class whose keys should be removed.

clearAll

void clearAll()

Deletes all information from the data store. Use with care!

putMap

@Deprecated
default void putMap(Class<?> c,
                                Map<String,String> map,
                                String name)

Deprecated. Use put(Class, String, Map).

putMap

@Deprecated
void putMap(Class<?> c,
                        Map<String,String> map)

Deprecated. Use put(Class, String, Map).

getMap

@Deprecated
Map<String,String> getMap(Class<?> c)

Deprecated. Use getMap(Class, String).

putList

@Deprecated
default void putList(Class<?> c,
                                 List<String> list,
                                 String name)

Deprecated. Use put(Class, String, Iterable).

putList

@Deprecated
void putList(Class<?> c,
                         List<String> list)

Deprecated. Use put(Class, String, Iterable).

getList

@Deprecated
List<String> getList(Class<?> c)

Deprecated. Use getList(Class, String).

putIterable

@Deprecated
default void putIterable(Class<?> c,
                                     Iterable<String> iterable,
                                     String name)

Deprecated. Use put(Class, String, Iterable).

getIterable

@Deprecated
Iterable<String> getIterable(Class<?> c,
                                         String name)

Deprecated. Use getList(Class, String).

get

@Deprecated
default String get(String name)

Deprecated. Use get(Class, String).

get

@Deprecated
default String get(String name,
                               String defaultValue)

Deprecated. Use get(Class, String, String).

getBoolean

@Deprecated
default boolean getBoolean(String name,
                                       boolean defaultValue)

Deprecated. Use getBoolean(Class, String, boolean).

getDouble

@Deprecated
default double getDouble(String name,
                                     double defaultValue)

Deprecated. Use getDouble(Class, String, double).

getFloat

@Deprecated
default float getFloat(String name,
                                   float defaultValue)

Deprecated. Use getFloat(Class, String, float).

getInt

@Deprecated
default int getInt(String name,
                               int defaultValue)

Deprecated. Use getInt(Class, String, int).

getLong

@Deprecated
default long getLong(String name,
                                 long defaultValue)

Deprecated. Use getLong(Class, String, long).

put

@Deprecated
default void put(String name,
                             String value)

Deprecated. Use put(Class, String, String).

put

@Deprecated
default void put(String name,
                             boolean value)

Deprecated. Use put(Class, String, boolean).

put

@Deprecated
default void put(String name,
                             double value)

Deprecated. Use put(Class, String, double).

put

@Deprecated
default void put(String name,
                             float value)

Deprecated. Use put(Class, String, float).

put

@Deprecated
default void put(String name,
                             int value)

Deprecated. Use put(Class, String, int).

put

@Deprecated
default void put(String name,
                             long value)

Deprecated. Use put(Class, String, long).

clear

@Deprecated
default void clear(String key)

Deprecated. Use remove(Class, String) or clear(Class).

clear

@Deprecated
void clear(String absolutePath,
                       String key)

Deprecated. Use remove(Class, String).

remove

@Deprecated
void remove(String absolutePath,
                        String key)

Deprecated. Use remove(Class, String).

putMap

@Deprecated
default void putMap(Map<String,String> map,
                                String key)

Deprecated. Use put(Class, String, Map).

putMap

@Deprecated
void putMap(String absolutePath,
                        Map<String,String> map)

Deprecated. Use put(Class, String, Map).

putMap

@Deprecated
void putMap(String absolutePath,
                        Map<String,String> map,
                        String key)

Deprecated. Use put(Class, String, Map).

getMap

@Deprecated
default Map<String,String> getMap(String key)

Deprecated. Use getMap(Class, String).

getMap

@Deprecated
Map<String,String> getMap(String absolutePath,
                                      String key)

Deprecated. Use getMap(Class, String).

putList

@Deprecated
default void putList(List<String> list,
                                 String key)

Deprecated. Use put(Class, String, Iterable).

putList

@Deprecated
void putList(String absolutePath,
                         List<String> list,
                         String key)

Deprecated. Use put(Class, String, Iterable).

putList

@Deprecated
void putList(String absolutePath,
                         List<String> list)

Deprecated. Use put(Class, String, Iterable).

getList

@Deprecated
default List<String> getList(String key)

Deprecated. Use getList(Class, String).

getList

@Deprecated
List<String> getList(String absolutePath,
                                 String key)

Deprecated. Use getList(Class, String).

putIterable

@Deprecated
default void putIterable(Iterable<String> iterable,
                                     String key)

Deprecated. Use put(Class, String, Iterable).

getIterable

@Deprecated
default Iterable<String> getIterable(String key)

Deprecated. User getList(Class, String).

clear

@Deprecated
void clear(Class<?> c,
                       String name)

Deprecated. Use remove(Class, String).