org.apache.juneau

Class BeanDictionaryMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

org.apache.juneau.BeanDictionaryMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class BeanDictionaryMap
extends LinkedHashMap<String,Object>

Represents a map of dictionary type names to bean classes that make up a bean dictionary.

In general, this approach for defining dictionary names for classes is used when it's not possible to use the @Bean.typeName() annotation.

Example:

// A bean dictionary map consisting of classes without @Bean.typeName() annotations // that require type names to be explicitly specified. public class MyBeanDictionaryMap extends BeanDictionaryMap { // Must provide a no-arg constructor! public MyBeanDictionaryMap() { addClass("MyBean", MyBean.class); addClass("MyBeanArray", MyBean[].class); addClass("StringArray", String[].class); addClass("String2dArray", String[][].class); addClass("IntArray", int[].class); addClass("Int2dArray", int[][].class); addClass("LinkedList", LinkedList.class); addClass("TreeMap", TreeMap.class); addCollectionClass("LinkedListOfInts", LinkedList.class, Integer.class); addCollectionClass("LinkedListOfR1", LinkedList.class, R1.class); addCollectionClass("LinkedListOfCalendar", LinkedList.class, Calendar.class); } } // Use it in a parser. ReaderParser p = JsonParser .create() .beanDictionary(MyBeanDictionaryMap.class) .build();

Subclasses must implement a public no-arg constructor so that it can be instantiated by the bean context code.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BeanDictionaryMap() Constructor.

Method Summary

Modifier and Type	Method and Description
protected BeanDictionaryMap	addClass(String typeName, Class<?> c) Add a dictionary name mapping for the specified class.
protected BeanDictionaryMap	addCollectionClass(String typeName, Class<? extends Collection> collectionClass, Object entryClass) Add a dictionary name mapping for the specified collection class with the specified entry class.
protected BeanDictionaryMap	addMapClass(String typeName, Class<? extends Map> mapClass, Object keyClass, Object valueClass) Add a dictionary name mapping for the specified map class with the specified key and value classes.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

BeanDictionaryMap

protected BeanDictionaryMap()

Constructor.

Method Detail

addClass

protected BeanDictionaryMap addClass(String typeName,
                                     Class<?> c)

Add a dictionary name mapping for the specified class.

Parameters:

typeName - The dictionary name of the class.

c - The class represented by the dictionary name.

Returns:

This object (for method chaining).

addMapClass

protected BeanDictionaryMap addMapClass(String typeName,
                                        Class<? extends Map> mapClass,
                                        Object keyClass,
                                        Object valueClass)

Add a dictionary name mapping for the specified map class with the specified key and value classes.

Parameters:

typeName - The dictionary name of the class.

mapClass - The map implementation class.

keyClass - The key class.

valueClass - The value class.

Returns:

This object (for method chaining).

addCollectionClass

protected BeanDictionaryMap addCollectionClass(String typeName,
                                               Class<? extends Collection> collectionClass,
                                               Object entryClass)

Add a dictionary name mapping for the specified collection class with the specified entry class.

Parameters:

typeName - The dictionary name of the class.

collectionClass - The collection implementation class.

entryClass - The entry class.

Returns:

This object (for method chaining).