com.codename1.properties.MapProperty Maven / Gradle / Ivy
/*
* Copyright (c) 2012, Codename One and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Codename One designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Codename One through http://www.codenameone.com/ if you
* need additional information or have any questions.
*/
package com.codename1.properties;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
/**
* Base class for a property as a Map which can contain multiple elements within it
*
* @author Shai Almog
*/
public class MapProperty extends PropertyBase, K> implements Iterable> {
private LinkedHashMap value = new LinkedHashMap();
private Class keyType;
private Class valueType;
/**
* Constructs a property with the given name
* @param name the name of the property
*/
public MapProperty(String name) {
super(name);
}
/**
* Constructs a property with the given name
* @param name the name of the property
* @param genericTypeKey the generic type of the key
* @param genericTypeValue the generic type of the value
*/
public MapProperty(String name, Class genericTypeKey, Class genericTypeValue) {
super(name);
validateCollectionType(genericTypeKey);
validateCollectionType(genericTypeValue);
keyType = genericTypeKey;
valueType = genericTypeValue;
}
/**
* Returns the class for the key element if it's defined or null if it isn't
* @return the class matching the map key
*/
public Class getKeyType() {
return keyType;
}
/**
* Returns the class for the value element if it's defined or null if it isn't
* @return the class matching the map value
*/
public Class getValueType() {
return valueType;
}
/**
* Gets the property value
* @param key the map key
* @return the property value
*/
public T2 get(T1 key) {
internalGet();
return value.get(key);
}
/**
* The size of the property list
* @return the number of elements
*/
public int size() {
internalGet();
return value.size();
}
/**
* Sets the property value and potentially fires a change event
* @param key the key to set
* @param v the new value
*/
public K set(T1 key, T2 v) {
value.put(key, v);
firePropertyChanged();
internalSet();
return (K)parent.parent;
}
/**
* Same as {@link #set(java.lang.Object, java.lang.Object)} here for coding convention convenience
* with map code
* @param key the key to set
* @param v the new value
*/
public K put(T1 key, T2 v) {
return set(key, v);
}
/**
* Removes the item matching the given key
* @param key the key
*/
public K remove(T1 key) {
value.remove(key);
internalSet();
return (K)parent.parent;
}
/**
* Compares this property to another property
* @param obj the other property
* @return true if they are equal in name and value
*/
@Override
public boolean equals(Object obj) {
if(!super.equals(obj)) {
return false;
}
MapProperty other = (MapProperty)obj;
return other.value.equals(value);
}
/**
* Returns the internal hashcode or 0 for null property
* @return the hashcode value
*/
@Override
public int hashCode() {
return value.hashCode();
}
/**
* Iterate over the elements of the property
* @return an iterator
*/
public Iterator> iterator() {
internalGet();
return value.entrySet().iterator();
}
/**
* Returns the set of keys in the map property
* @return the keys
*/
public Set keySet() {
return value.keySet();
}
/**
* Returns the set of values in the map property
* @return the values
*/
public Collection valueSet() {
return value.values();
}
/**
* Returns a copy of the content as a new map
* @return a map
*/
public Map asMap() {
internalGet();
return new LinkedHashMap(value);
}
/**
* Returns a copy of the content as a new map but if the value is a PropertyBusinessObject it will
* be converted to a Map
* @return a map
*/
public Map asExplodedMap() {
Map m = new LinkedHashMap();
for(T1 k : value.keySet()) {
T2 v = value.get(k);
if(v instanceof PropertyBusinessObject) {
m.put(k, ((PropertyBusinessObject)v).getPropertyIndex().toMapRepresentation());
} else {
m.put(k, v);
}
}
internalGet();
return m;
}
/**
* Sets the entire content of the property
* @param t the map of elements to set
* @return the parent object for chaining
*/
public K setMap(Map t) {
value.clear();
value.putAll(t);
firePropertyChanged();
internalSet();
return (K)parent.parent;
}
/**
* Remove all the elements from the map
*/
public void clear() {
internalSet();
value.clear();
}
}