er.extensions.foundation

Class ERXDictionaryUtilities

java.lang.Object

er.extensions.foundation.ERXDictionaryUtilities

public class ERXDictionaryUtilities
extends Object

Collection of NSDictionary utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXDictionaryUtilities.NSDictionaryKeyValueComparator Compares dictionary keys based on the value they are associated with.

Constructor Summary

Constructors

Constructor and Description
ERXDictionaryUtilities()

Method Summary

Modifier and Type	Method and Description
static <K,V> void	_removeMatchingEntries(NSMutableDictionary<? extends K,? extends V> snapshot1, NSMutableDictionary<? extends K,? extends V> snapshot2, boolean removeInverse)
static <K,V> NSDictionary<K,V>	deepClone(NSDictionary<K,V> dict, boolean onlyCollections) Returns a deep clone of the given dictionary.
static <K,V> NSDictionary<K,V>	dictionaryByRemovingFromDictionaryKeysInArray(NSDictionary<K,V> d, NSArray<K> a) Removes an array of keys from a dictionary and returns the result.
static <K,V> NSDictionary<K,V>	dictionaryByRemovingKeysNotInArray(NSDictionary<K,V> d, NSArray<K> a) Creates a new dictionary with only the keys and objects in the array.
static NSMutableDictionary<String,Object>	dictionaryFromObjectWithKeyMappings(Object object, NSDictionary<String,ERXKey<?>> keyMappings) Creates a dictionary from an object according to the given key mappings, skipping null values.
static NSDictionary<String,Object>	dictionaryFromObjectWithKeys(Object object, ERXKey... keys) Creates a dictionary from an objects and an array of key paths
static NSDictionary<String,Object>	dictionaryFromObjectWithKeys(Object object, NSArray<String> keys) Creates a dictionary from an objects and an array of key paths
static NSDictionary<String,Object>	dictionaryFromObjectWithKeys(Object object, String... keys) Creates a dictionary from an object and a list of key paths
static NSDictionary	dictionaryFromPropertyList(String name, NSBundle bundle) Creates an NSDictionary from a resource associated with a given bundle that is in property list format.
static <K,V> NSDictionary<K,V>	dictionaryWithDictionaryAndDictionary(NSDictionary<? extends K,? extends V> dict1, NSDictionary<? extends K,? extends V> dict2) Creates an immutable dictionary containing all of the keys and objects from two dictionaries.
static NSDictionary	dictionaryWithObjectsAndKeys(Object[] objectsAndKeys) Creates a dictionary from a list of alternating objects and keys starting with an object.
static <T> NSArray<T>	keysSortedByValueAscending(NSDictionary<T,?> d)
static String	queryStringForDictionary(NSDictionary<?,?> dict, String separator) Encodes a dictionary into a string that can be used in a request uri.
static String	queryStringForDictionary(NSDictionary<?,?> dict, String separator, String encoding) Encodes a dictionary into a string that can be used in a request uri.
static <K,V> void	removeMatchingEntries(NSMutableDictionary<? extends K,? extends V> dict1, NSMutableDictionary<? extends K,? extends V> dict2) Removes entries from both dictionaries that match, leaving you with two dictionaries containing only values that did NOT match.
static <K,V> NSDictionary<K,V>	removeNullValues(NSDictionary<K,V> dict)
static <K,V> void	setObjectForKeys(NSMutableDictionary<K,V> dictionary, V object, NSArray<K> keys) Sets the object for each of the keys in the array on a mutable dictionary.
static NSArray<String>	stringKeysSortedAscending(NSDictionary<String,?> d)

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXDictionaryUtilities

public ERXDictionaryUtilities()

Method Detail

dictionaryWithDictionaryAndDictionary

public static <K,V> NSDictionary<K,V> dictionaryWithDictionaryAndDictionary(NSDictionary<? extends K,? extends V> dict1,
                                                                            NSDictionary<? extends K,? extends V> dict2)

Creates an immutable dictionary containing all of the keys and objects from two dictionaries.

Parameters:

dict1 - the first dictionary

dict2 - the second dictionary

Returns:

immutbale dictionary containing the union of the two dictionaries.

dictionaryFromPropertyList

public static NSDictionary dictionaryFromPropertyList(String name,
                                                      NSBundle bundle)

Creates an NSDictionary from a resource associated with a given bundle that is in property list format.

Parameters:

name - name of the file or resource.

bundle - NSBundle to which the resource belongs.

Returns:

NSDictionary de-serialized from the property list.

dictionaryWithObjectsAndKeys

public static NSDictionary dictionaryWithObjectsAndKeys(Object[] objectsAndKeys)

Creates a dictionary from a list of alternating objects and keys starting with an object.

Parameters:

objectsAndKeys - alternating list of objects and keys

Returns:

NSDictionary containing all of the object-key pairs.

dictionaryByRemovingFromDictionaryKeysInArray

public static <K,V> NSDictionary<K,V> dictionaryByRemovingFromDictionaryKeysInArray(NSDictionary<K,V> d,
                                                                                    NSArray<K> a)

Removes an array of keys from a dictionary and returns the result.

Parameters:

d - dictionary to be pruned

a - array of keys to be pruned

Returns:

pruned dictionary

dictionaryByRemovingKeysNotInArray

public static <K,V> NSDictionary<K,V> dictionaryByRemovingKeysNotInArray(NSDictionary<K,V> d,
                                                                         NSArray<K> a)

Creates a new dictionary with only the keys and objects in the array. The result is the objects for the intersection of keys in the dictionary and the array. This is the opposite of dictionaryByRemovingFromDictionaryKeysInArray.

Parameters:

d - dictionary to be pruned

a - array of keys to be included

Returns:

pruned dictionary

removeNullValues

public static <K,V> NSDictionary<K,V> removeNullValues(NSDictionary<K,V> dict)

dictionaryFromObjectWithKeys

public static NSDictionary<String,Object> dictionaryFromObjectWithKeys(Object object,
                                                                       NSArray<String> keys)

Creates a dictionary from an objects and an array of key paths

Parameters:

object - object to pull the values from

keys - array of keys

Returns:

NSDictionary containing all of the object-key pairs.

dictionaryFromObjectWithKeys

public static NSDictionary<String,Object> dictionaryFromObjectWithKeys(Object object,
                                                                       String... keys)

Creates a dictionary from an object and a list of key paths

Parameters:

object - object to pull the values from

keys - list of keys

Returns:

Returns a NSDictionary containing all of the object-key pairs.

dictionaryFromObjectWithKeys

public static NSDictionary<String,Object> dictionaryFromObjectWithKeys(Object object,
                                                                       ERXKey... keys)

Creates a dictionary from an objects and an array of key paths

Parameters:

object - object to pull the values from

keys - list of keys

Returns:

Returns a NSDictionary containing all of the object-key pairs.

dictionaryFromObjectWithKeyMappings

public static NSMutableDictionary<String,Object> dictionaryFromObjectWithKeyMappings(Object object,
                                                                                     NSDictionary<String,ERXKey<?>> keyMappings)

Creates a dictionary from an object according to the given key mappings, skipping null values.

Usage:

 NSDictionary<String, Object> data = dictionaryFromObjectWithKeyMappings(eo, NSDictionary.of("key1", EO.ATTRIBUTE1, "key2", EO.ATTRIBUTE2);
 

Result:

 {"key1" = "valueForAttribute1"; "key2" = "valueForAttribute2"}
 

Parameters:

object - object to pull the values from

keyMappings - keypath mapping for keys

Returns:

Returns a NSDictionary containing all of the object-key pairs.

stringKeysSortedAscending

public static NSArray<String> stringKeysSortedAscending(NSDictionary<String,?> d)

keysSortedByValueAscending

public static <T> NSArray<T> keysSortedByValueAscending(NSDictionary<T,?> d)

Parameters:

d - dictionary to sort keys from

Returns:

keys from d sorted by ascending value they are mapped to

removeMatchingEntries

public static <K,V> void removeMatchingEntries(NSMutableDictionary<? extends K,? extends V> dict1,
                                               NSMutableDictionary<? extends K,? extends V> dict2)

Removes entries from both dictionaries that match, leaving you with two dictionaries containing only values that did NOT match. Note that this comparison considers null == EO/NSKeyValueCoding.NullValue.

Parameters:

dict1 - the first dictionary

dict2 - the second dictionary

_removeMatchingEntries

public static <K,V> void _removeMatchingEntries(NSMutableDictionary<? extends K,? extends V> snapshot1,
                                                NSMutableDictionary<? extends K,? extends V> snapshot2,
                                                boolean removeInverse)

setObjectForKeys

public static <K,V> void setObjectForKeys(NSMutableDictionary<K,V> dictionary,
                                          V object,
                                          NSArray<K> keys)

Sets the object for each of the keys in the array on a mutable dictionary.

Parameters:

dictionary - dictionary to mutate. a null dictionary is a no-op.

object - object to set. an exception will be thrown if object is null.

keys - array of keys to invoke setObjectForKey() for each key. a null or empty array is a no-op.

deepClone

public static <K,V> NSDictionary<K,V> deepClone(NSDictionary<K,V> dict,
                                                boolean onlyCollections)

Returns a deep clone of the given dictionary. A deep clone will attempt to clone the keys and values (deeply) of this dictionary as well as the dictionary itself.

Parameters:

dict - the dictionary to clone

onlyCollections - if true, only collections in this dictionary will be cloned, not individual values

Returns:

a deep clone of dict

queryStringForDictionary

public static String queryStringForDictionary(NSDictionary<?,?> dict,
                                              String separator)

Encodes a dictionary into a string that can be used in a request uri.

Parameters:

dict - dictionary with form values

separator - optional value separator

queryStringForDictionary

public static String queryStringForDictionary(NSDictionary<?,?> dict,
                                              String separator,
                                              String encoding)

Encodes a dictionary into a string that can be used in a request uri.

Parameters:

dict - dictionary with form values

separator - optional value separator