org.apache.juneau.BeanMapEntry Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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 org.apache.juneau;
import java.util.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.transform.*;
/**
* Represents a single entry in a bean map.
*
*
* This class can be used to get and set property values on a bean, or to get metadata on a property.
*
*
Example:
*
* // Construct a new bean
* Person p = new Person();
*
* // Wrap it in a bean map
* BeanMap<Person> b = BeanContext.DEFAULT .forBean(p);
*
* // Get a reference to the birthDate property
* BeanMapEntry birthDate = b.getProperty("birthDate" );
*
* // Set the property value
* birthDate.setValue(new Date(1, 2, 3, 4, 5, 6));
*
* // Or if the DateSwap.DEFAULT_ISO8601DT is registered with the bean context, set a transformed value
* birthDate.setValue("'1901-03-03T04:05:06-5000'" );
*
*/
public class BeanMapEntry implements Map.Entry {
private final BeanMap beanMap;
private final BeanPropertyMeta meta;
private final String pName;
/**
* Constructor.
*
* @param beanMap The bean map that this entry belongs to.
* @param property The bean property.
* @param pName The bean property name.
*/
protected BeanMapEntry(BeanMap beanMap, BeanPropertyMeta property, String pName) {
this.beanMap = beanMap;
this.meta = property;
this.pName = pName;
}
@Override /* Map.Entry */
public String getKey() {
return meta.getName();
}
/**
* Returns the value of this property.
*
*
* If there is a {@link PojoSwap} 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 {@link Date} and the bean property has the
* {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
* {@link Swap#value() @Swap.value()} annotation, this method will return a String containing an
* ISO8601 date-time string value.
*/
@Override /* Map.Entry */
public Object getValue() {
return meta.get(this.beanMap, pName);
}
/**
* Sets the value of this property.
*
*
* If the property is an array of type {@code X}, then the value can be a {@code Collection} or {@code X[]} or
* {@code Object[]}.
*
*
* If the property is a bean type {@code X}, then the value can either be an {@code X} or a {@code Map}.
*
*
* If there is a {@link PojoSwap} 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 {@link Date} and the bean property has the
* {@link org.apache.juneau.transforms.DateSwap.ISO8601DT} swap associated with it through the
* {@link Swap#value() @Swap.value()} annotation, the value being passed in must be a String
* containing an ISO8601 date-time string value.
*
* @return The set value after it's been converted.
*/
@Override /* Map.Entry */
public Object setValue(Object value) {
return meta.set(this.beanMap, pName, value);
}
/**
* Returns the bean map that contains this property.
*
* @return The bean map that contains this property.
*/
public BeanMap getBeanMap() {
return this.beanMap;
}
/**
* Returns the metadata about this bean property.
*
* @return Metadata about this bean property.
*/
public BeanPropertyMeta getMeta() {
return this.meta;
}
@Override /* Object */
public String toString() {
return this.getKey() + "=" + this.getValue();
}
}