Package net.solarnetwork.settings.support

Class SettingUtils

java.lang.Object

net.solarnetwork.settings.support.SettingUtils

public final class SettingUtils
extends Object

Helper utilities for settings.

Since:

1.43

Version:

1.1

Author:

matt

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SettingUtils.KeyedListCallback<T>	API to map a list element into a set of SettingSpecifier objects.

Method Summary

Modifier and Type	Method	Description
static <T> BasicGroupSettingSpecifier	dynamicListSettingSpecifier(String key, Collection<T> collection, SettingUtils.KeyedListCallback<T> mapper)	Get a dynamic list GroupSettingSpecifier.
static Map<String,Object>	keyedSettingDefaults(List<SettingSpecifier> settings)	Extract all KeyedSettingSpecifier keys and associated default values from a list of settings.
static List<SettingSpecifier>	mappedWithPrefix(List<SettingSpecifier> settings, String prefix)	Add a prefix to the keys of all MappableSpecifier settings.
static Set<String>	secureKeys(List<SettingSpecifier> settings)	Get a set of setting keys that require secure handling.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

dynamicListSettingSpecifier

public static <T> BasicGroupSettingSpecifier dynamicListSettingSpecifier(String key,
 Collection<T> collection,
 SettingUtils.KeyedListCallback<T> mapper)

Get a dynamic list GroupSettingSpecifier.

Type Parameters:

T - the group item type

Parameters:

key - the group setting key

collection - The collection to turn into settings.

mapper - A helper to map individual elements into settings.

Returns:

The resulting GroupSettingSpecifier.

secureKeys

public static Set<String> secureKeys(List<SettingSpecifier> settings)

Get a set of setting keys that require secure handling.

This method considers the following settings for secure handling :

1. TextFieldSettingSpecifier.isSecureTextEntry() that returns true

The returned set maintains the same iteration order as settings.

Parameters:

settings - the settings to check (null allowed)

Returns:

the set of secure entry keys, never null

mappedWithPrefix

public static List<SettingSpecifier> mappedWithPrefix(List<SettingSpecifier> settings,
 String prefix)

Add a prefix to the keys of all MappableSpecifier settings.

Parameters:

settings - the settings to map

prefix - the prefix to add to all MappableSpecifier settings

Returns:

list of mapped settings, or null if settings is null

Since:

1.1

keyedSettingDefaults

public static Map<String,Object> keyedSettingDefaults(List<SettingSpecifier> settings)

Extract all KeyedSettingSpecifier keys and associated default values from a list of settings.

Both GroupSettingSpecifier.getGroupSettings() and ParentSettingSpecifier.getChildSettings() will be included in the returned map.

Parameters:

settings - the settings to extract the keyed defaults from

Returns:

a map of keyed setting keys to associated default values, never null

Since:

1.1