com.feilong.lib.beanutils.DynaBeanPropertyMapDecorator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
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.

There is a newer version: 4.0.8

Show newest version

/*
 * 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 org.apache.commons.beanutils.DynaBean;

/**
 * 
 * Decorates a {@link DynaBean} to provide Map behavior.
 * 
 *
 * 
 * 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 can be achieved either by wrapping the {@link DynaBean} prior to
 * providing it to the technology to process or by providing a Map
 * accessor method on the DynaBean implementation:
 * 
 * 
 * 
 *         public Map<String, Object> getMap() {
 *             return new DynaBeanPropertyMapDecorator(this);
 *         }
 * 
 * 
 * 
 *
 * 
 * This, for example, could be used in JSTL in the following way to access
 * a DynaBean's fooProperty:
 * 

 * ${myDynaBean.map.fooProperty}
 * 
 * 
 *
 * Usage
 *
 * 
 * To decorate a {@link DynaBean} simply instantiate this class with the
 * target {@link DynaBean}:
 * 
 *
 * 
 * Map<String, Object> fooMap = new DynaBeanPropertyMapDecorator(fooDynaBean);
 * 
 *
 * 
 * The above example creates a read only Map.
 * To create a Map which can be modified, construct a
 * DynaBeanPropertyMapDecorator with the read only
 * attribute set to false:
 * 
 *
 * 
 * Map<String, Object> fooMap =
 *   new DynaBeanPropertyMapDecorator(fooDynaBean, false);
 * 
 *
 * Limitations
 * 
 * In this implementation the entrySet(), keySet()
 * and values() methods create an unmodifiable
 * Set and it does not support the Map's clear()
 * and remove() operations.
 * 
 *
 * @since BeanUtils 1.9.0
 * @version $Id$
 */
public class DynaBeanPropertyMapDecorator extends BaseDynaBeanMapDecorator{

    /**
     * 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 DynaBeanPropertyMapDecorator(final DynaBean dynaBean, final boolean readOnly){
        super(dynaBean, readOnly);
    }

    /**
     * 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 DynaBeanPropertyMapDecorator(final DynaBean dynaBean){
        super(dynaBean);
    }

    @Override
    protected String convertKey(final String propertyName){
        return propertyName;
    }
}