com.feilong.lib.beanutils.BaseDynaBeanMapDecorator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.feilong.lib.beanutils;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.commons.beanutils.DynaBean;
/**
*
* A base class for decorators providing Map behavior on
* {@link DynaBean}s.
*
*
*
* The motivation for this implementation is to provide access to {@link DynaBean}
* properties in technologies that are unaware of BeanUtils and {@link DynaBean}s -
* such as the expression languages of JSTL and JSF.
*
*
*
* This rather technical base class implements the methods of the
* {@code Map} interface on top of a {@code DynaBean}. It was introduced
* to handle generic parameters in a meaningful way without breaking
* backwards compatibility of the {@link DynaBeanMapDecorator} class: A
* map wrapping a {@code DynaBean} should be of type {@code Map}.
* However, when using these generic parameters in {@code DynaBeanMapDecorator}
* this would be an incompatible change (as method signatures would have to
* be adapted). To solve this problem, this generic base class is added
* which allows specifying the key type as parameter. This makes it easy to
* have a new subclass using the correct generic parameters while
* {@code DynaBeanMapDecorator} could still remain with compatible
* parameters.
*
*
* @param
* the type of the keys in the decorated map
* @since BeanUtils 1.9.0
* @version $Id$
*/
public abstract class BaseDynaBeanMapDecorator implements Map{
private final DynaBean dynaBean;
private final boolean readOnly;
private transient Set keySet;
// ------------------- Constructors ----------------------------------
/**
* Constructs a read only Map for the specified
* {@link DynaBean}.
*
* @param dynaBean
* The dyna bean being decorated
* @throws IllegalArgumentException
* if the {@link DynaBean} is null.
*/
public BaseDynaBeanMapDecorator(final DynaBean dynaBean){
this(dynaBean, true);
}
/**
* Construct a Map for the specified {@link DynaBean}.
*
* @param dynaBean
* The dyna bean being decorated
* @param readOnly
* true if the Map is read only
* otherwise false
* @throws IllegalArgumentException
* if the {@link DynaBean} is null.
*/
public BaseDynaBeanMapDecorator(final DynaBean dynaBean, final boolean readOnly){
if (dynaBean == null){
throw new IllegalArgumentException("DynaBean is null");
}
this.dynaBean = dynaBean;
this.readOnly = readOnly;
}
// ------------------- public Methods --------------------------------
/**
* Indicate whether the Map is read only.
*
* @return true if the Map is read only,
* otherwise false.
*/
public boolean isReadOnly(){
return readOnly;
}
// ------------------- java.util.Map Methods -------------------------
/**
* clear() operation is not supported.
*
* @throws UnsupportedOperationException
*/
@Override
public void clear(){
throw new UnsupportedOperationException();
}
/**
* Indicate whether the {@link DynaBean} contains a specified
* value for one (or more) of its properties.
*
* @param key
* The {@link DynaBean}'s property name
* @return true if one of the {@link DynaBean}'s
* properties contains a specified value.
*/
@Override
public boolean containsKey(final Object key){
final DynaClass dynaClass = getDynaBean().getDynaClass();
final DynaProperty dynaProperty = dynaClass.getDynaProperty(toString(key));
return (dynaProperty == null ? false : true);
}
/**
* Indicates whether the decorated {@link DynaBean} contains
* a specified value.
*
* @param value
* The value to check for.
* @return true if one of the the {@link DynaBean}'s
* properties contains the specified value, otherwise
* false.
*/
@Override
public boolean containsValue(final Object value){
final DynaProperty[] properties = getDynaProperties();
for (DynaProperty propertie : properties){
final String key = propertie.getName();
final Object prop = getDynaBean().get(key);
if (value == null){
if (prop == null){
return true;
}
}else{
if (value.equals(prop)){
return true;
}
}
}
return false;
}
/**
*
* Returns the Set of the property/value mappings
* in the decorated {@link DynaBean}.
*
*
*
* Each element in the Set is a Map.Entry
* type.
*
*
* @return An unmodifiable set of the DynaBean
* property name/value pairs
*/
@Override
public Set> entrySet(){
final DynaProperty[] properties = getDynaProperties();
final Set> set = new HashSet<>(properties.length);
for (DynaProperty propertie : properties){
final K key = convertKey(propertie.getName());
final Object value = getDynaBean().get(propertie.getName());
set.add(new MapEntry<>(key, value));
}
return Collections.unmodifiableSet(set);
}
/**
* Return the value for the specified key from
* the decorated {@link DynaBean}.
*
* @param key
* The {@link DynaBean}'s property name
* @return The value for the specified property.
*/
@Override
public Object get(final Object key){
return getDynaBean().get(toString(key));
}
/**
* Indicate whether the decorated {@link DynaBean} has
* any properties.
*
* @return true if the {@link DynaBean} has
* no properties, otherwise false.
*/
@Override
public boolean isEmpty(){
return (getDynaProperties().length == 0);
}
/**
*
* Returns the Set of the property
* names in the decorated {@link DynaBean}.
*
*
*
* N.B.For {@link DynaBean}s whose associated {@link DynaClass}
* is a {@link MutableDynaClass} a new Set is created every
* time, otherwise the Set is created only once and cached.
*
*
* @return An unmodifiable set of the {@link DynaBean}s
* property names.
*/
@Override
public Set keySet(){
if (keySet != null){
return keySet;
}
// Create a Set of the keys
final DynaProperty[] properties = getDynaProperties();
Set set = new HashSet<>(properties.length);
for (DynaProperty propertie : properties){
set.add(convertKey(propertie.getName()));
}
set = Collections.unmodifiableSet(set);
// Cache the keySet if Not a MutableDynaClass
final DynaClass dynaClass = getDynaBean().getDynaClass();
if (!(dynaClass instanceof MutableDynaClass)){
keySet = set;
}
return set;
}
/**
* Set the value for the specified property in
* the decorated {@link DynaBean}.
*
* @param key
* The {@link DynaBean}'s property name
* @param value
* The value for the specified property.
* @return The previous property's value.
* @throws UnsupportedOperationException
* if
* isReadOnly() is true.
*/
@Override
public Object put(final K key,final Object value){
if (isReadOnly()){
throw new UnsupportedOperationException("Map is read only");
}
final String property = toString(key);
final Object previous = getDynaBean().get(property);
getDynaBean().set(property, value);
return previous;
}
/**
* Copy the contents of a Map to the decorated {@link DynaBean}.
*
* @param map
* The Map of values to copy.
* @throws UnsupportedOperationException
* if
* isReadOnly() is true.
*/
@Override
public void putAll(final Map map){
if (isReadOnly()){
throw new UnsupportedOperationException("Map is read only");
}
for (final Map.Entry e : map.entrySet()){
put(e.getKey(), e.getValue());
}
}
/**
* remove() operation is not supported.
*
* @param key
* The {@link DynaBean}'s property name
* @return the value removed
* @throws UnsupportedOperationException
*/
@Override
public Object remove(final Object key){
throw new UnsupportedOperationException();
}
/**
* Returns the number properties in the decorated
* {@link DynaBean}.
*
* @return The number of properties.
*/
@Override
public int size(){
return getDynaProperties().length;
}
/**
* Returns the set of property values in the
* decorated {@link DynaBean}.
*
* @return Unmodifiable collection of values.
*/
@Override
public Collection