com.edorasware.commons.core.entity

Class NamedValues

java.lang.Object

com.edorasware.commons.core.entity.NamedValues

public abstract class NamedValues
extends Object

Provides utility methods related to working with named values.

Method Summary

Modifier and Type	Method and Description
static <T extends NamedValueWithSource> com.google.common.collect.ImmutableCollection<T>	filterBySource(String source, Collection<T> namedValues) Filters the NamedValue elements that are associated with the specified source.
static Map<String,Object>	flatten(Map<String,Object> map, char separator)
static Map<String,Object>	flatten(Map<String,Object> map, String prefix, char separator)
static <T extends NamedValue> com.google.common.collect.ImmutableSortedSet<String>	getDuplicateNames(Collection<T> namedValues) Returns all names that occur more than once.
static <T extends NamedValue> com.google.common.collect.ImmutableCollection<T>	mergeNamedValues(Collection<T> namedValuesBase, Collection<T> namedValuesWithPrecedence) Merges two collections of NamedValue elements.
static <T extends NamedValue> com.google.common.collect.ImmutableCollection<T>	mergeNamedValues(List<Collection<T>> namedValuesCollections) Merges collections of NamedValue elements.
static Map<String,Object>	toMap(Collection<? extends NamedValue> namedValues) Transforms the given NamedValues into a Map of String keys and Object values.
static Map<String,Object>	toMap(Collection<? extends NamedValue> namedValues, char nameSeparator) Transforms the given NamedValues into a nested Map of String keys and values of the given type or Map.
static <T> Map<String,T>	toMap(Collection<? extends NamedValue> namedValues, Class<T> expectedValueType) Transforms the given NamedValues into a Map of String keys and values of the given type.

Methods inherited from class java.lang.Object

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

Method Detail

toMap

public static Map<String,Object> toMap(Collection<? extends NamedValue> namedValues)

Transforms the given NamedValues into a Map of String keys and Object values.

Parameters:

namedValues - the named values to transform into a map

Returns:

the map

toMap

public static <T> Map<String,T> toMap(Collection<? extends NamedValue> namedValues,
                                      Class<T> expectedValueType)

Transforms the given NamedValues into a Map of String keys and values of the given type.

Type Parameters:

T - the type of the value

Parameters:

namedValues - the named values to transform into a map

expectedValueType - the expected type of the values

Returns:

the map

toMap

public static Map<String,Object> toMap(Collection<? extends NamedValue> namedValues,
                                       char nameSeparator)

Transforms the given NamedValues into a nested Map of String keys and values of the given type or Map. The nesting of maps happens based on the occurrence of the given separator within the names.

Parameters:

namedValues - the named values to transform into a map

nameSeparator - the name separator

Returns:

the map

flatten

public static Map<String,Object> flatten(Map<String,Object> map,
                                         char separator)

flatten

public static Map<String,Object> flatten(Map<String,Object> map,
                                         String prefix,
                                         char separator)

getDuplicateNames

public static <T extends NamedValue> com.google.common.collect.ImmutableSortedSet<String> getDuplicateNames(Collection<T> namedValues)

Returns all names that occur more than once.

Type Parameters:

T - the type of the named value

Parameters:

namedValues - the named values to investigate

Returns:

the duplicate names

mergeNamedValues

public static <T extends NamedValue> com.google.common.collect.ImmutableCollection<T> mergeNamedValues(Collection<T> namedValuesBase,
                                                                                                       Collection<T> namedValuesWithPrecedence)

Merges two collections of NamedValue elements. In case of name clashes, elements in the second collection win over elements in the first collection.

Type Parameters:

T - the type of the named value

Parameters:

namedValuesBase - collection of the base named values

namedValuesWithPrecedence - collection of the named values with precedence

Returns:

the merged named values in random order

mergeNamedValues

public static <T extends NamedValue> com.google.common.collect.ImmutableCollection<T> mergeNamedValues(List<Collection<T>> namedValuesCollections)

Merges collections of NamedValue elements. In case of name clashes, elements in higher collections win over elements in lower collections, where a higher collection means a collection with a larger index compared to another collection.

Type Parameters:

T - the type of the named value

Parameters:

namedValuesCollections - the collections of named values to merge

Returns:

the merged named values in random order

filterBySource

public static <T extends NamedValueWithSource> com.google.common.collect.ImmutableCollection<T> filterBySource(String source,
                                                                                                               Collection<T> namedValues)

Filters the NamedValue elements that are associated with the specified source.

Type Parameters:

T - the type of the named value with source

Parameters:

source - the source

namedValues - the named values to filter

Returns:

the matching named values