Package org.apache.juneau.internal

Class DelegateBeanMap<T>

java.lang.Object
java.util.AbstractMap<String,Object>
org.apache.juneau.BeanMap<T>
org.apache.juneau.internal.DelegateBeanMap<T>
Type Parameters:
T - The class type of the wrapped bean.
All Implemented Interfaces:
Map<String,Object>, Delegate<T>
public class DelegateBeanMap<T> extends BeanMap<T>
Represents a wrapped BeanMap where property values can be overridden, removed, or reordered without affecting the underlying bean.

Provides the filterKeys(List) method for specifying the keys to keep in the bean map and in what order they should appear.

See Also:

  • Constructor Details

    • DelegateBeanMap

      public DelegateBeanMap(T bean, BeanSession session)
      Constructor.
      Parameters:
      bean - The bean being wrapped.
      session - The bean session that created this bean map.

  • Method Details

    • addKey

      public void addKey(String key)
      Add a key in the next position.
      Parameters:
      key - The key to add.

    • put

      public Object put(String key, Object val)
      Description copied from class: BeanMap
      Sets a property on the bean.

      If there is a ObjectSwap associated with this bean property or bean property type class, then you must pass in a transformed value. For example, if the bean property type class is a Date and the bean property has the TemporalDateSwap.IsoInstant swap associated with it through the @Swap(value) annotation, the value being passed in must be a String containing an ISO8601 date-time string value.

      Example:

      // Construct a bean with a 'birthDate' Date field Person person = new Person(); // Create a bean context and add the ISO8601 date-time swap BeanContext beanContext = BeanContext.create().swaps(DateSwap.ISO8601DT.class).build(); // Wrap our bean in a bean map BeanMap<Person> beanMap = beanContext.toBeanMap(person); // Set the field beanMap.put("birthDate", "'1901-03-03T04:05:06-5000'");

      Specified by:
      put in interface Map<String,Object>
      Overrides:
      put in class BeanMap<T>
      Parameters:
      key - The name of the property to set.
      val - The value to set the property to.
      Returns:
      If the bean context setting beanMapPutReturnsOldValue is true, then the old value of the property is returned. Otherwise, this method always returns null.

    • get

      public Object get(Object key)
      Description copied from class: BeanMap
      Gets a property on the bean.

      If there is a ObjectSwap associated with this bean property or bean property type class, then this method will return the transformed value. For example, if the bean property type class is a Date and the bean property has the TemporalDateSwap.IsoInstant swap associated with it through the @Swap(value) annotation, this method will return a String containing an ISO8601 date-time string value.

      Example:

      // Construct a bean with a 'birthDate' Date field Person person = new Person(); person.setBirthDate(new Date(1, 2, 3, 4, 5, 6)); // Create a bean context and add the ISO8601 date-time swap BeanContext beanContext = BeanContext.create().swaps(DateSwap.ISO8601DT.class).build(); // Wrap our bean in a bean map BeanMap<Person> beanMap = beanContext.toBeanMap(person); // Get the field as a string (i.e. "'1901-03-03T04:05:06-5000'") String birthDate = beanMap.get("birthDate");

      Specified by:
      get in interface Map<String,Object>
      Overrides:
      get in class BeanMap<T>
      Parameters:
      key - The name of the property to get.
      Returns:
      The property value.

    • keySet

      public Set<String> keySet()
      Description copied from class: BeanMap
      Returns the names of all properties associated with the bean.

      The returned set is unmodifiable.

      Specified by:
      keySet in interface Map<String,Object>
      Overrides:
      keySet in class BeanMap<T>

    • filterKeys

      public DelegateBeanMap<T> filterKeys(List<String> keys)
      Remove all but the specified properties from this bean map.

      This does not affect the underlying bean.

      Parameters:
      keys - The remaining keys in the bean map (in the specified order).
      Returns:
      This object.

    • remove

      public Object remove(Object key)
      Specified by:
      remove in interface Map<String,Object>
      Overrides:
      remove in class AbstractMap<String,Object>

    • getMeta

      public BeanMeta<T> getMeta()
      Description copied from class: BeanMap
      Returns the metadata associated with this bean map.
      Overrides:
      getMeta in class BeanMap<T>
      Returns:
      The metadata associated with this bean map.

    • entrySet

      public Set<Map.Entry<String,Object>> entrySet()
      Description copied from class: BeanMap
      Returns all the properties associated with the bean.
      Specified by:
      entrySet in interface Map<String,Object>
      Overrides:
      entrySet in class BeanMap<T>
      Returns:
      A new set.

    • getProperties

      public Collection<BeanPropertyMeta> getProperties()
      Description copied from class: BeanMap
      Returns a simple collection of properties for this bean map.
      Overrides:
      getProperties in class BeanMap<T>
      Returns:
      A simple collection of properties for this bean map.

    • forEachProperty

      public BeanMap<T> forEachProperty(Predicate<BeanPropertyMeta> filter, Consumer<BeanPropertyMeta> action)
      Description copied from class: BeanMap
      Performs an action on each property in this bean map.
      Overrides:
      forEachProperty in class BeanMap<T>
      Parameters:
      filter - The filter to apply to properties.
      action - The action.
      Returns:
      This object.