com.codename1.properties

Class MapProperty<T1,T2,K>

java.lang.Object

com.codename1.properties.PropertyBase<Map.Entry<T1,T2>,K>

com.codename1.properties.MapProperty<T1,T2,K>

All Implemented Interfaces:

Iterable<Map.Entry<T1,T2>>

public class MapProperty<T1,T2,K>
extends PropertyBase<Map.Entry<T1,T2>,K>
implements Iterable<Map.Entry<T1,T2>>

Base class for a property as a Map which can contain multiple elements within it

Constructor Summary

Constructors

Constructor and Description
MapProperty(String name) Constructs a property with the given name
MapProperty(String name, Class genericTypeKey, Class genericTypeValue) Constructs a property with the given name

Method Summary

Modifier and Type	Method and Description
Map<T1,Object>	asExplodedMap() Returns a copy of the content as a new map but if the value is a PropertyBusinessObject it will be converted to a Map
Map<T1,T2>	asMap() Returns a copy of the content as a new map
void	clear() Remove all the elements from the map
boolean	equals(Object obj) Compares this property to another property
T2	get(T1 key) Gets the property value
Class	getKeyType() Returns the class for the key element if it's defined or null if it isn't
Class	getValueType() Returns the class for the value element if it's defined or null if it isn't
int	hashCode() Returns the internal hashcode or 0 for null property
Iterator<Map.Entry<T1,T2>>	iterator() Iterate over the elements of the property
Set<T1>	keySet() Returns the set of keys in the map property
K	put(T1 key, T2 v) Same as set(java.lang.Object, java.lang.Object) here for coding convention convenience with map code
K	remove(T1 key) Removes the item matching the given key
K	set(T1 key, T2 v) Sets the property value and potentially fires a change event
K	setMap(Map<T1,T2> t) Sets the entire content of the property
int	size() The size of the property list
Collection<T2>	valueSet() Returns the set of values in the map property

Methods inherited from class com.codename1.properties.PropertyBase

addChangeListener, bindGlobalGetListener, bindGlobalSetListener, firePropertyChanged, getClientProperty, getGenericType, getLabel, getName, putClientProperty, removeChangeListener, setLabel, stopListening, toString, validateCollectionType

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapProperty

public MapProperty(String name)

Constructs a property with the given name

Parameters:

name - the name of the property

MapProperty

public MapProperty(String name,
                   Class genericTypeKey,
                   Class genericTypeValue)

Constructs a property with the given name

Parameters:

name - the name of the property

genericTypeKey - the generic type of the key

genericTypeValue - the generic type of the value

Method Detail

getKeyType

public Class getKeyType()

Returns the class for the key element if it's defined or null if it isn't

Returns:

the class matching the map key

getValueType

public Class getValueType()

Returns the class for the value element if it's defined or null if it isn't

Returns:

the class matching the map value

get

public T2 get(T1 key)

Gets the property value

Parameters:

key - the map key

Returns:

the property value

size

public int size()

The size of the property list

Returns:

the number of elements

set

public K set(T1 key,
             T2 v)

Sets the property value and potentially fires a change event

Parameters:

key - the key to set

v - the new value

put

public K put(T1 key,
             T2 v)

Same as set(java.lang.Object, java.lang.Object) here for coding convention convenience with map code

Parameters:

key - the key to set

v - the new value

remove

public K remove(T1 key)

Removes the item matching the given key

Parameters:

key - the key

equals

public boolean equals(Object obj)

Compares this property to another property

Overrides:

equals in class PropertyBase<Map.Entry<T1,T2>,K>

Parameters:

obj - the other property

Returns:

true if they are equal in name and value

hashCode

public int hashCode()

Returns the internal hashcode or 0 for null property

Overrides:

hashCode in class Object

Returns:

the hashcode value

iterator

public Iterator<Map.Entry<T1,T2>> iterator()

Iterate over the elements of the property

Specified by:

iterator in interface Iterable<Map.Entry<T1,T2>>

Returns:

an iterator

keySet

public Set<T1> keySet()

Returns the set of keys in the map property

Returns:

the keys

valueSet

public Collection<T2> valueSet()

Returns the set of values in the map property

Returns:

the values

asMap

public Map<T1,T2> asMap()

Returns a copy of the content as a new map

Returns:

a map

asExplodedMap

public Map<T1,Object> asExplodedMap()

Returns a copy of the content as a new map but if the value is a PropertyBusinessObject it will be converted to a Map

Returns:

a map

setMap

public K setMap(Map<T1,T2> t)

Sets the entire content of the property

Parameters:

t - the map of elements to set

Returns:

the parent object for chaining

clear

public void clear()

Remove all the elements from the map