au.com.cybersearch2.classybean

Class BeanMap

java.lang.Object

java.util.AbstractMap<String,Object>

au.com.cybersearch2.classybean.BeanMap

All Implemented Interfaces:

Map<String,Object>

public class BeanMap
extends AbstractMap<String,Object>

BeanMap Creates a Map by wrapping an object.

Author:

Andrew Bowley 28/05/2014

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BeanMap(Object bean) Construct a BeanMap instance by wrapping an Object which follows Java Bean spec.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(Object key) Returns true if this map contains a mapping for the specified key.
Set<Map.Entry<String,Object>>	entrySet() Returns a Set view of the mappings contained in this map.
Object	get(Object key) Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
Object	put(String key, Object value) Associates the specified value with the specified key in this map (optional operation).
int	size() Returns the number of key-value mappings in this map.

Methods inherited from class java.util.AbstractMap

clear, containsValue, equals, hashCode, isEmpty, keySet, putAll, remove, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BeanMap

public BeanMap(Object bean)

Construct a BeanMap instance by wrapping an Object which follows Java Bean spec.

Parameters:

bean - Object with setters and getters to access properties

Method Detail

get

public Object get(Object key)

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Specified by:

get in interface Map<String,Object>

Overrides:

get in class AbstractMap<String,Object>

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Throws:

ClassCastException - if the key is of an inappropriate type for this map (optional)

NullPointerException - if the specified key is null and this map does not permit null keys (optional)

put

public Object put(String key,
         Object value)

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Specified by:

put in interface Map<String,Object>

Overrides:

put in class AbstractMap<String,Object>

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Throws:

UnsupportedOperationException - if the put operation is not supported by this map

ClassCastException - if the class of the specified key or value prevents it from being stored in this map

NullPointerException - if the specified key or value is null and this map does not permit null keys or values

IllegalArgumentException - if some property of the specified key or value prevents it from being stored in this map

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface Map<String,Object>

Specified by:

entrySet in class AbstractMap<String,Object>

Returns:

a set view of the mappings contained in this map

size

public int size()

Returns the number of key-value mappings in this map.

Specified by:

size in interface Map<String,Object>

Overrides:

size in class AbstractMap<String,Object>

Returns:

int

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class AbstractMap<String,Object>

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

Throws:

ClassCastException - if the key is of an inappropriate type for this map (optional)

NullPointerException - if the specified key is null and this map does not permit null keys (optional)